Skip to navigation

Atualizar origem comercial

View as Markdown

Atualiza uma origem comercial existente.

Regras:

  • a operação atualiza somente os campos enviados;
  • campos omitidos continuam com o valor atual;
  • use ativo = "N" para inativar;
  • use ativo = "S" para reativar;
  • a API não possui rota de exclusão para esse cadastro auxiliar.

Exemplo de uso:

PUT {{base_url}}/simplificav2/origem_comercial/88
Authorization: Bearer {{bearer_token}}
Content-Type: application/json
{
"origem": "Indicação de parceiro",
"ativo": "S"
}

Authentication

AuthorizationBearer

Token privado usado para consultar dados da plataforma.

Como usar:

  • obtenha o token privado da sua empresa;
  • envie Authorization: Bearer SEU_TOKEN_PRIVADO;
  • não use x-api-key neste módulo.

Path parameters

idintegerRequired
Identificador da origem comercial.

Request

This endpoint expects an object.
origemstring or nullOptional
Novo nome da origem comercial.
ativostring or nullOptional

Novo status da origem. Use S para ativar ou N para inativar.

Response

Origem atualizada com sucesso.
statusstring
mensagemstring
dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error