UsuáriosAtualizar Usuário

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 "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "name": "João Silva",
  "roleId": "8a3f1b2c-4e5d-6f7a-8b9c-0d1e2f3a4b5c"
}'
{
  "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
}
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}

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
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).

Body

application/json
namestring

Nome completo do usuário.

roleIdstring

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

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.