Skip to content

Atualiza um empregador

Request

Atualiza um empregador.

Security
BasicAuth
Path
idstringrequired

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

Headers
If-Matchstringrequired

Para atualizar um documento é necessário o header com o valor do campo _etag atual do documento.

Bodyapplication/json
namestring

Razão social do empregador.

cpfstring^\d{11}$

CPF do empregador, apenas números. Necessário que exista ou este campo ou o campo CNPJ mutuamente exclusivos.

cnpjstring^[0-9A-Z]{12}\d{2}$

CNPJ do empregador, sem máscara. Aceita o formato numérico tradicional ou o alfanumérico (12 caracteres alfanuméricos maiúsculos seguidos de 2 dígitos verificadores). Necessário que exista ou este campo ou o campo CPF mutuamente exclusivos.

external_idstring

Identificador externo a ser preenchido pelo cliente. Deve ser único. IMPORTANTE: Para remover a chave em um PATCH, deve ser enviado como valor uma string vazia ("").

addressobject
curl -i -X PATCH \
  -u '<username>:<password>' \
  'https://api-docs.tiquetaque.app/_mock/openapi/payment-sources/{id}' \
  -H 'Content-Type: application/json' \
  -H 'If-Match: string' \
  -d '{
    "name": "string",
    "cpf": "string",
    "cnpj": "string",
    "external_id": "string",
    "address": {
      "cep": "01307002",
      "street_name": "string",
      "street_number": "string",
      "complement": "string",
      "state": "SC",
      "city": "São Paulo"
    }
  }'

Responses

Dados atualizados com sucesso.

Bodyapplication/json
_idstring
_createdstring(IsoDateTimeTzModel)^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}[+-][0-2]\d:[0-...
Example:"2024-09-29T08:00-03:00"
_etagstring(EtagModel)

Hash a ser usado como conteúdo do header If-Match para realizar atualização e remoções de documentos

_statusstring
Example:"OK"
Response
{
  "_id": "string",
  "_created": "2024-09-29T08:00-03:00",
  "_etag": "string",
  "_status": "OK"
}