Update a service

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

Updates a service. Send the full service: the body follows the same rules as creation.

A product identifier is also accepted, and the record becomes a service.

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

Request

Path parameters

idstringrequired

Service identifier.

Example: NmIzYWU1NGItN2IxNi00NzQ2LTg4ZmUtOGM2ZjY3YzlhOTMxOjIyOTE1.

Headers

User-Agentstringrequired

Identification of your application.

Example: MinhaIntegracao/1.0.

Request body

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

namestringrequired

Service name.

Up to 100 characters.

descriptionstring

Service description.

Up to 2000 characters.

valuenumberrequired

Service unit price.

archivedbooleanrequired

Archives the service.

externalobject

Fields of external

idstring

Service identifier in your system.

Up to 100 characters.Accepts: null.

Responses

• 200

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

• 422

  Invalid identifier, or one from another account, in the URL (uriValidationErr), nonexistent service (resourceValidationErr with message: work service not found; there is no 404) or invalid body.

  resourceValidationErr →
• 429

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

• 500

  Unexpected server error.