Add a label to the order

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

Adds a work order label to the work order. Returns the label.

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.

labelobjectrequired

Fields of label

idstringrequired

Identifier of a work order label in the account.

Responses

• 201

  Label added.

• 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.

• 409

  Label already added to the order (resourceAlreadyExists).

• 422

  Nonexistent label, of another type (message: label is not order label) or invalid identifier (resourceValidationErr). Invalid order identifier: uriValidationErr.

• 429

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

• 500

  Unexpected server error.