Skip to main content

Alterando o status de uma pessoa colaboradora

Sobre este guia​

Através deste guia, demonstraremos como alterar o status de uma pessoa colaboradora.

Passo a passo​

Ambientes
  • Ambiente de homologação: https://uat-collaborators-api.acessorh.com.br;
  • Ambiente de produção: https://collaborators-api.acessorh.com.br.

  1. Obtenha um token OAuth válido​

    Caso tenha dúvidas de como obter um token visite a seção sobre autenticação.

  2. Alterando o status de uma pessoa colaboradora​

    Após gerar um token de acesso válido, faça uma requisição para o endpoint de alteração de status de uma pessoa colaboradora na nossa API REST (PATCHapi/v1/employees/{EMPLOYEE_ID}/status?account={ACCOUNT}), enviando o employeeId e account.

    Parâmetro account

    Este parâmetro deve conter o UUID de qual account dentro da sua organization você deseja efetuar essa operação.

    Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

    Parâmetro employeeId

    Este parâmetro deve conter o UUID da pessoa colaboradora que você deseja alterar o status.

    Exemplo de formato de um UUID: 00000000-0000-0000-0000-000000000000

    Abaixo um exemplo da requisição, onde no campo active para ativar uma pessoa colaborador informe o valor true e para desativar o valor false:

    curl --location 'https://collaborators-api.acessorh.com.br/api/v1/employees/{/status?account={ACCOUNT}' \
    --request PATCH \
    --header 'accountid: {ACCOUNT}' \
    --header 'authorization: Bearer {ACCESS_TOKEN}' \
    --data '{
        "active": false
    }'