Atualizar Usuário

Atualiza parcialmente os dados de um usuário da empresa. Apenas os campos enviados são alterados; campos omitidos permanecem inalterados.

Regras:

name e roleId só podem ser alterados em usuários ativos.
Não é possível alterar o e-mail do usuário.
Não é possível alterar um usuário com perfil principal (MAIN).
Não é possível rebaixar o único administrador (RESPONSIBLE) da conta.
Retorna 404 se o usuário não pertencer à empresa autenticada.

curl -X PATCH "https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -H "Content-Digest: example_string" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
}'

import requests
import json

url = "https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000"
headers = {
  "Content-Type": "application/json",
  "Signature-Input": "example_string",
  "Signature": "example_string",
  "Content-Digest": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
}
data = {
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
}

response = requests.patch(url, headers=headers, json=data)
print(response.json())

const response = await fetch("https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000", {
  method: "PATCH",
  headers: {
  "Content-Type": "application/json",
  "Signature-Input": "example_string",
  "Signature": "example_string",
  "Content-Digest": "example_string",
  "Authorization": "Bearer YOUR_API_TOKEN"
},
  body: JSON.stringify({
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
})
});

const data = await response.json();
console.log(data);

package main

import (
    "fmt"
    "net/http"
    "bytes"
    "encoding/json"
)

func main() {
    data := []byte(`{
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
}`)

    req, err := http.NewRequest("PATCH", "https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000", bytes.NewBuffer(data))
    if err != nil {
        panic(err)
    }

    req.Header.Set("Content-Type", "application/json")
    req.Header.Set("Signature-Input", "example_string")
    req.Header.Set("Signature", "example_string")
    req.Header.Set("Content-Digest", "example_string")
    req.Header.Set("Authorization", "Bearer YOUR_API_TOKEN")

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    fmt.Println("Response Status:", resp.Status)
}

require 'net/http'
require 'json'

uri = URI('https://api-sandbox.contasimples.com/users/v1/users/550e8400-e29b-41d4-a716-446655440000')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(uri)
request['Content-Type'] = 'application/json'
request['Signature-Input'] = 'example_string'
request['Signature'] = 'example_string'
request['Content-Digest'] = 'example_string'
request['Authorization'] = 'Bearer YOUR_API_TOKEN'
request.body = '{
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
}'

response = http.request(request)
puts response.body

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "email": "joao.silva@empresa.com.br",
  "name": "João Silva",
  "phone": "11999999999",
  "role": {
    "id": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c",
    "name": "Contador(a)"
  },
  "active": true
}

{
  "error": "Bad Request",
  "message": "Um ou mais parâmetros da requisição são inválidos.",
  "code": 400,
  "requestId": "123e4567-e89b-12d3-a456-426614174000",
  "details": [
    "O campo exemplo deve ter um valor entre 5 e 100.",
    "datas devem estar no formato YYYY-MM-DD."
  ]
}

PATCH

/users/v1/users/{userId}

PATCH

Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token

Bearer Tokenstring

Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

path

userIdstring

Required

ID do usuário (UUID v4) — use o valor do campo id retornado em GET /users/v1/users (ex.: 550e8400-e29b-41d4-a716-446655440000).

Format: uuid

Content-Typestring

Required

The media type of the request body

Options: application/json

header

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

header

Content-Digeststring

Hash do corpo da requisição no formato da RFC 9530, com sha-256 ou sha-512, por exemplo sha-256=:X48E9qOokqqrvdts8nOJRJN3OWDUoyWxBf7kbu9DBPE=:. É obrigatório quando a requisição tem corpo e a credencial tem chave pública, e nesse caso o Signature-Input precisa incluir o componente content-digest.

namestring

Nome completo do usuário.

Min length: 1

roleIdstring

ID do perfil a ser atribuído ao usuário — use GET /users/v1/roles para obter os IDs disponíveis.

Format: uuid

Request Preview

Response

Response will appear here after sending the request

Authentication

header

Authorizationstring

Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Path Parameters

userIdstring

Required

ID do usuário (UUID v4) — use o valor do campo id retornado em GET /users/v1/users (ex.: 550e8400-e29b-41d4-a716-446655440000).

Example:

550e8400-e29b-41d4-a716-446655440000

Headers

Signature-Inputstring

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Content-Digeststring

Body

application/json

namestring

Nome completo do usuário.

Example:

João Silva

roleIdstring

ID do perfil a ser atribuído ao usuário — use GET /users/v1/roles para obter os IDs disponíveis.

Example:

8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c

Responses

idstring

Required

Identificador único do usuário.

emailstring

Required

E-mail do usuário.

namestring

Required

Nome do usuário.

phonestring

Telefone do usuário.

roleobject

Required

Perfil de acesso atribuído ao usuário na empresa.

activeboolean

Required

Indica se o usuário está ativo na empresa.

Was this page helpful?