Comment on the order

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

Adds a comment to the work order on behalf of an author from your system. The success response uses status 200.

Requires the X-Api-Key, User-Agent and Content-Type: application/json headers. Limit: 1 request per second (learn more).

Request

Path parameters

idstringrequired

Work order identifier.

Example: NDJiMWQ0YzQtOWNmOC00NWE2LTg2MjItYjNjNzZjZjk0MmM4OjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

JSON, sent with the Content-Type: application/json header.

messagestringrequired

Comment text.

Up to 500 characters.

typestringrequired

Visibility: team (team), public (customer), manager (managers) or corporate.

Accepted values: team, public, manager, corporate.

archivedboolean

Creates the comment already archived.

Default: false.

postedByobjectrequired

Comment author in your system.

Fields of postedBy

externalIdstringrequired

Author identifier in your system. The same value always produces the same postedBy.id.

Up to 50 characters.

namestringrequired

Author name.

Up to 50 characters.

avatarUrlstring

URL of the author's photo.

Up to 500 characters.Accepts: null.

Responses

• 200

  Comment created.

• 401

  API key missing (Missing API Key) or invalid (Invalid API Key). See Authentication.

• 403

  Account blocked (Account blocked), expired (Account expired) or on a plan that does not allow integration (Account plan not allowed). See Authentication.

• 404

  Resource not found. The response body is empty.

• 422

  Invalid body (resourceValidationErr): postedBy, message or type missing, type outside the list or texts over the limit. Invalid order identifier: uriValidationErr.

• 429

  Limit of 1 request per second exceeded. See Rate limit.

• 500

  Unexpected server error.