v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Atualizar pessoa

put/persons/{person_id}

Path parameters

person_idinteger required

ID do registro da pessoa.

Request body

namestring

Nome do contato.

address_complementstring

Complemento de endereço.

address_numberstring

Número do endereço.

address_postal_codestring

CEP do endereço da pessoa.

addressstring

Logradouro da pessoa.

districtstring

Bairro da pessoa.

avatarstring

URL apontando para uma imagem de avatar.

birth_daystring date

Data de nascimento da pessoa.

city_idinteger

ID da cidade da pessoa.

company_idinteger

ID da empresa da pessoa.

manager_idinteger

ID do CS responsável da conta.

cpfstring

CPF da pessoa. Formatos aceitos: 123.456.789-01, 12345678901.

customer_atstring date

Data em que essa pessoa se tornou cliente Formato: AAAA-MM-DD.

genderstring

Gênero dessa pessoa ("Masculino" ou "Feminino").

job_titlestring

Título do cargo da pessoa.

observationstring

Observações sobre a pessoa.

websitestring

URL apontando para o website da pessoa.

facebookstring

URL apontando para o perfil do Facebook da pessoa.

linkedinstring

URL apontando para o perfil do LinkedIn da pessoa.

contactEmailsstring[]

Array referenciando emails da pessoa.

contactPhonesstring[]

Array referenciando telefones da pessoa.

Response

200

successboolean

messagestring

Example response

{
  "success": true,
  "message": "OK",
  "data": {
    "id": 748,
    "account_id": 748,
    "city_id": 748,
    "owner_id": 748,
    "manager_id": 748,
    "cpf": "708.901.040-69",
    "name": "Nome teste",
    "hash": "b14c52a2b2364e2f75ff696397a20890",
    "website": "CésarYagoFelipeAssis.com.br",
    "job_title": "Pedreiro",
    "gender": "Masculino",
    "birth_day": "1990-02-25",
    "observation": "Mora em Porto alegre",
    "customer_at": "2020-02-26",
    "facebook": "www.facebook.com.br/CésarYagoFelipeAssis",
    "linkedin": "www.linkedin.com.br/CésarYagoFelipeAssis",
    "address_postal_code": "97035-200",
    "address": "Avenida Circular",
    "address_number": "12",
    "address_complement": "quadra 2",
    "district": "Juscelino Kubitschek",
    "created_at": "2020-08-17 10:21:50",
    "status": 1,
    "city": {
      "id": 1,
      "uf": "RS",
      "name": "Santa Catarina"
    },
    "contact_emails": {
      "id": 748,
      "account_id": 748,
      "company_id": 748,
      "person_id": 748,
      "type": "Comercial",
      "email": "alex@santiago.com"
    },
    "contact_phones": {
      "id": 748,
      "account_id": 748,
      "company_id": 748,
      "person_id": 748,
      "type": "Comercial",
      "phone": "9999999999"
    }
  }
}