Comentar na ordem

POSThttps://carchost.fieldcontrol.com.br/orders/{id}/comments

Adiciona um comentário à ordem de serviço em nome de um autor do seu sistema. A resposta de sucesso usa o status 200.

Requer os headers X-Api-Key, User-Agent e Content-Type: application/json. Limite: 1 requisição por segundo (saiba mais).

Requisição

Parâmetros de caminho

idstringobrigatório

Identificador da ordem de serviço.

Exemplo: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

Headers

User-Agentstringobrigatório

Identificação da sua aplicação.

Exemplo: MinhaIntegracao/1.0.

Corpo da requisição

JSON, enviado com o header Content-Type: application/json.

messagestringobrigatório

Texto do comentário.

Até 500 caracteres.

typestringobrigatório

Visibilidade: team (equipe), public (cliente), manager (gestores) ou corporate.

Valores aceitos: team, public, manager, corporate.

archivedboolean

Cria o comentário já arquivado.

Padrão: false.

postedByobjectobrigatório

Autor do comentário no seu sistema.

Campos de postedBy

externalIdstringobrigatório

Identificador do autor no seu sistema. O mesmo valor gera sempre o mesmo postedBy.id.

Até 50 caracteres.

namestringobrigatório

Nome do autor.

Até 50 caracteres.

avatarUrlstring

URL da foto do autor.

Até 500 caracteres.Aceita: null.

Respostas

• 200

  Comentário criado.

• 401

  Chave de API ausente (Missing API Key) ou inválida (Invalid API Key). Ver Autenticação.

• 403

  Conta bloqueada (Account blocked), expirada (Account expired) ou com plano que não permite integração (Account plan not allowed). Ver Autenticação.

• 404

  Recurso não encontrado. O corpo da resposta é vazio.

• 422

  Corpo inválido (resourceValidationErr): postedBy, message ou type ausentes, type fora da lista ou textos acima do limite. Identificador da ordem inválido: uriValidationErr.

• 429

  Limite de 1 requisição por segundo excedido. Ver Limite de requisições.

• 500

  Erro inesperado no servidor.