Transferir responsável pelas tarefas e processos

Permite transferir o responsável pelas tarefas, processos e tarefas de modelos de processo de um usuário em um determinado escritório.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Dicionário para propriedades enviadas

Request body

  • transferFromInChargeUserId - Id do usuário que hoje é o responsável. Só mudam de responsável os itens que estão com ele.
  • transferToInChargeUserId - Id do usuário que passa a ser o responsável. Precisa ser um usuário ativo do escritório.
  • taskCustomerIds - Ids dos clientes cujas tarefas em aberto serão transferidas.
  • transferTasksWithoutCustomer - Quando true, transfere também as tarefas em aberto sem cliente.
  • processCustomerIds - Ids dos clientes cujos processos agendados ou em andamento serão transferidos, junto com as recorrências de processo desses clientes.
  • processTaskTemplateIds - Ids das tarefas dos modelos de processo que serão transferidas, retornados em stepTemplates[].taskTemplates[].id na rota de listagem de templates de processos.

Os ids de usuário são os retornados na listagem de usuários, e os ids de cliente, na listagem de clientes.


Comportamento

  • É preciso informar ao menos um entre taskCustomerIds, transferTasksWithoutCustomer, processCustomerIds e processTaskTemplateIds.
  • Tarefas concluídas, subtarefas e processos concluídos ou cancelados não são transferidos.
  • Ids de cliente que não pertencem ao escritório são ignorados.
  • Se o novo responsável não for administrador, ele precisa ter acesso aos departamentos e clientes dos itens transferidos.
  • A transferência é feita por completo ou não é feita: se alguma validação falhar, nada muda de responsável.

Erros

  • 400 - usuário de origem não informado ou nada a transferir (message: Erro ao validar os dados da requisição.), novo responsável não encontrado no escritório (INCHARGE_USER_NOT_FOUND), ou novo responsável sem acesso a um departamento ou cliente dos itens transferidos.
  • 403 - o usuário não tem permissão no escritório.
Path Params
string
required

Id do escritório.

Body Params
string
Defaults to Obrigatório

Id do usuário que hoje é o responsável pelas tarefas e processos.

string
Defaults to Obrigatório

Id do usuário que receberá a transferência.

taskCustomerIds
array of strings
Defaults to Opcional

Ids dos clientes cujas tarefas em aberto serão transferidas.

taskCustomerIds
boolean
Defaults to false

Indica se as tarefas em aberto sem cliente também serão transferidas.

processCustomerIds
array of strings
Defaults to Opcional

Ids dos clientes cujos processos agendados ou em andamento e recorrências de processo serão transferidos.

processCustomerIds
processTaskTemplateIds
array of strings
Defaults to Opcional

Ids das tarefas dos modelos de processo que serão transferidas.

processTaskTemplateIds
Headers
string

Requer autenticação via API Key no header da requisição. Exemplo: X-API-Key: Sua chave.

string

Requer autenticação via Id do usuário no header da requisição. Exemplo: X-User-Id: Id do usuário.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json