Skip to content

Desativar pessoas em lote

Request

Permite inativar em lote pessoas, alterando seu status para "inativo". Útil para automações de limpeza de cadastros ou para perfis que não precisam mais estar ativos.

Security
BearerAuth
Bodyapplication/jsonrequired

IDs das pessoas a serem desativadas

uuidsArray of strings, [ 1 .. 10 ] itemsrequired

máximo de 10 IDs

Example:
[ "4BBDAE00-2242-4703-9310-9946D6C2D0A3", "B6270060-3AB7-4E66-A99B-71084E385F47" ]
curl -i -X POST \
  https://api-v2.contaazul.com/v1/pessoas/inativar \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "uuids": [
      "4BBDAE00-2242-4703-9310-9946D6C2D0A3",
      "B6270060-3AB7-4E66-A99B-71084E385F47"
    ]
  }'

Responses

OK

Bodyapplication/json
Array [
ativosArray of strings

Lista de IDs das pessoas ativadas

Example:
[ "4BBDAE00-2242-4703-9310-9946D6C2D0A3" ]
inativosArray of strings

Lista de IDs das pessoas inativadas

Example:
[ "B6270060-3AB7-4E66-A99B-71084E385F47" ]
todosArray of strings

Lista de todos os IDs das pessoas fornecidos na requisição

Example:
[ "4BBDAE00-2242-4703-9310-9946D6C2D0A3", "B6270060-3AB7-4E66-A99B-71084E385F47" ]
]
Response
[ { "ativos": [], "inativos": [], "todos": [] } ]