PATCH /person/:id (Person)
update_personUpdate one or more fields of a person's profile, including personal data, contact, address, and permissions, in the Conexa system.
Instructions
Edição de uma ou n informações de uma pessoa no sistema Conexa. ⚠ Fique atento ao produto do seu sistema. Há campos que não são necessários!
Campos do body:
name (string): Nome da pessoa
nationality (string): Define a nacionalidade da pessoa
placeOfBirth (string): Define a naturalidade da pessoa
maritalStatus (string): Define o estado civil da pessoa. Seu valor deve estar entre os seguintes: ' married', 'single', 'divorced', 'widowed', 'not informed'
isForeign (boolean): Define se a pessoa é estrangeira
foreignData (object): Objeto contendo os dados estrangeiros da pessoa, serão considerados se isForeign for true
foreignData.zipCode (string): Código postal estrangeiro da pessoa
foreignData.contry (string): País da pessoa estrangeira
foreignData.city (string): Cidade da pessoa estrangeira
foreignData.state (string): Estado ou Unidade Administrativa da pessoa estrangeira
foreignData.street (string): Rua da pessoa estrangeira
foreignData.number (string): Número da residência estrangeira da pessoa
foreignData.neighborhood (string): Bairro da pessoa estrangeira
foreignData.additionalDetails (string): Complementos para o endereço estrangeiro da pessoa
foreignData.document (string): Número de documento estrangeiro de identificação da pessoa
isCompanyPartner (boolean): Sinaliza se a pessoa pode assinar documentos em nome do cliente a qual é associada
isGuarantor (boolean): Sinaliza se a pessoa é fiadora do cliente a qual está associada
cpf (string): Número de CPF da pessoa, será considerado se isForeign for false
rg (string): Número de RG da pessoa, será considerado se isForeign for false
issuinAutohrity (string): Órgão expedidor do documento de RG da pessoa, será considerado se isForeign for false
birthDate (string): Data de nascimento da pessoa. Formato: yyyy-MM-dd
cellNumber (string): Número de celular da pessoa, deve possuir 10 ou 11 dígitos
phones (string[]): Array contendo os números de telefone da pessoa. Deve possuir 11 dígitos e números estrangeiros deve inicia com o símbolo +.
emails (string[]): Array contendo os emails da pessoa.
sex (string): Indica o sexo da pessoa, deve ser uma das seguintes iniciais: 'M' => 'Masculine' , 'F' => 'Feminine' , 'U' => 'Not informed' , um valor diferente dos informados será identificado como Not informed
jobTitle (string): Nome do cargo da pessoa
profession (string): Profissão da pessoa
resume (string): Breve currículo da pessoa
notes (string): Observações da pessoa
address (object): Objeto contendo os dados de endereço da pessoa. Válido para pessoas não estrangeiras
address.zipCode (string): CEP da pessoa
address.state (string): Sigla do estado em que a pessoa reside
address.city (string): Nome da cidade em que a pessoa reside
address.street (string): Nome da rua em que a pessoa reside
address.number (integer): Número da residênica da pessoa
address.neighborhood (string): Bairro em que a pessoa reside
address.additionalDetails (string): Complemento do endereço da pessoa
hasLoginAccess (boolean): Indica se a pessoa terá acesso à Área do Clliente
login (string): Define o login da pessoa caso esta tenha acesso à Área do Cliente. O login deve conter: Somente letras , números , @ . - + ou _
password (string): Define a senha da pessoa caso esta tenha acesso. Deve conter pelo menos 6 caracteres, compostos por letras e números
permissions (string[]): Array contendo as permissões que a pessoa terá no sistema. Os valores válidos são: 'finance' , 'orders' , 'rooms' , 'sharedSpaces' , 'assistance' , 'correspondences' e 'printing'
accessId (string): Identificador da pessoa (id, nº do cartão e etc) no dispositivo de controle de acesso (catracas, biometria, etc)
canReceiveMail (boolean): Sinaliza se a pessoa pode receber correspondências para o cliente ao qual é associada
color (string): Código de cor hexadecimal que será associado ao perfil da pessoa
printFeeId (string): Valor utilizado unicamente para identificar o cliente durante a importação do arquivo com as tarifações de impressão. Só pode ser cadastrado por usuários do tipo admin
extensionNumbers (string[]): Array contendo os números de ramal ou extensões da pessoa
urlLinkedin (string): Endereço perfil da pessoa no LinkedIn
urlInstagram (string): Endereço do perfil da pessoa no Instagram
urlFacebook (string): Endereço do perfil da pessoa no Facebook
urlTwitter (string): Endereço do perfil da pessoa no Twitter
useFacialRecognitionPhoto (boolean): Define se a imagem da pessoa deve ser utilizada para o reconhecimento facial. Depende de configurações e equipamento específico
devices (array of objects): Array contendo os objetos que representam os dispositivos da pessoa que serão cadastrados
devices[].nickname (string): Apelido do dispositivo
devices[].macAddress (string): Endereço de mac do dispositivo
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | Valor de :id na rota /person/:id | |
| body | Yes | Corpo JSON da requisição (campos na descrição da tool) |