Pular para o conteúdo principal

Atualizar um serviço

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

Atualiza um serviço. Envie o serviço completo: o corpo segue as mesmas regras da criação.

Um identificador de produto também é aceito, e o registro passa a ser um serviço.

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 do serviço.

Exemplo: NmIzYWU1NGItN2IxNi00NzQ2LTg4ZmUtOGM2ZjY3YzlhOTMxOjIyOTE1.

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.

namestringobrigatório

Nome do serviço.

Até 100 caracteres.

descriptionstring

Descrição do serviço.

Até 2000 caracteres.

valuenumberobrigatório

Valor unitário do serviço.

archivedbooleanobrigatório

Arquiva o serviço.

externalobject
Campos de external
idstring

Identificador do serviço no seu sistema.

Até 100 caracteres.Aceita: null.

Respostas

  • 200

    Serviço atualizado.

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

  • 422

    Identificador inválido ou de outra conta na URL (uriValidationErr), serviço inexistente (resourceValidationErr com message: work service not found; não há 404) ou corpo inválido.

    resourceValidationErr →
  • 429

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

  • 500

    Erro inesperado no servidor.