Skip to main content

Update a work order type

PUThttps://carchost.fieldcontrol.com.br/services/{id}

Updates a work order type. The body follows the same rules as creation; an omitted archived keeps the current value.

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 type identifier.

Example: MTk6MjI5MTU=.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

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

namestringrequired

Work order type name.

From 5 to 100 characters.

durationintegerrequired

Estimated service duration, in minutes.

From 0 to 2147483647.

archivedboolean

Archives the work order type.

Default: false.

Responses

  • 200

    Work order type updated.

  • 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). An invalid identifier, or one from another account, in the URL also returns this error, with property: '@.id'.

  • 429

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

  • 500

    Unexpected server error.