Alterando

Alterando um cliente

Existe um processo de alteração de cadastro da empresa do Cliente + inclusão/alteração de representantes legais. A ação a ser tomada, depende dos dados enviados pela requisição. Para mais detalhes, consulte o diagrama no final desta página.

PUT /v1/organization/CLIENT_ID/companies/CODIGO DO CLIENTE

Endpoint para alterar um cliente.

Todos os endpoints, necessitarão dos 2 tokens no Header e deverá ser passado na URL o CLIENT_ID. Esse assunto foi tratado em Primeiros Passos, caso não tenha este código, acione o time de suporte.

Headers:

Name	Value
Content-Type	application/json
Accept	application/json
Authorization	Bearer <token de Autenticação>
x-spro-authorization	<token de Autorização>

URL Parameters: exemplo: /v1/organization/CLIENT_ID/companies/CODIGO DO CLIENTE

Campo	Exemplo de Valor	Descrição
CLIENT_ID	01jawvcvfahk52qsaerzfa0tyj	Código da sua empresa (passado pelo time de integração após o setup). Detalhado em: Primeiros passos.
CODIGO DO CLIENTE	01hsk7nf8s05cgr9ewyx6xj39c	Código do cliente (campo ulid do cadastro dele)

Body:

{
        "alias": "Barreto e Rodrigues e Filhos 2",
        "name": "Barreto e Rodrigues e Filhos 2",
        "email": "[e-mail]",
        "phone": "(87) 90410-25832",
        "whatsapp": "(22) 98676-25122",
        "country_id": 846,
        "state_id": 397,
        "city_id": 196,
        "address": "Largo Renan, 2. Bloco C",
        "number": "68111",
        "complement": "Bc. 8 Ap. 47",
        "neighborhood": "Sul",
        "postal_code": "95765-846",        
        "status": true,
        "customers": [
            {                
                "registration_number": "81282527045",
                "name": "Michael Keenan Franco",
                "email": "[e-mail]",
                "phone": "(62)98178-0000",
                "whatsapp": "(62)98178-0000",
                "status": false,
            },
            {
                "registration_number": "57606444242",
                "name": "Elizabeth Giovani Kerr",
                "email": "[e-mail]",
                "phone": "(00)00000-0000",
                "whatsapp": "(00)00000-0000"
            }
        ]
    }
}

Detalhes dos campos:

Veja os detalhes aqui.

O Campo "registration_number" da empresa do Cliente (no caso CNPJ) não pode alterado. Caso envie essa informação, ela será descartada.

Response:

200

{
    "company": {
        "id": 1,
        "ulid": "01hsk7nf8s05cgr9ewyx6xj39c",
        "status": true,
        "type": "J",
        "registration_number": "58312998000140",
        "alias": "Barreto e Rodrigues e Filhos",
        "name": "Barreto e Rodrigues e Filhos",
        "email": "[e-mail]",
        "phone": "(87) 90410-2583",
        "whatsapp": "(22) 98676-2512",
        "country_id": 846,
        "state_id": 397,
        "city_id": 196,
        "address": "Largo Renan, 2. Bloco C",
        "number": "68111",
        "complement": "Bc. 8 Ap. 47",
        "neighborhood": "Sul",
        "postal_code": "95765-846",
        "customers": [
            {
                "id": 1,
                "ulid": "01hsf065qevt1176yz3cgtk227",
                "status": false,
                "registration_number": "81282527045",
                "name": "Michael Keenan Franco",
                "email": "[e-mail]",
                "phone": "(62)98178-0000",
                "whatsapp": "(62)98178-0000",
                "bird_id": {
                    "is_valid": false,
                    "verified_at": "2024-04-23 15:09:50"
                },
                "videoconference": {
                    "verification": false,
                    "link": null
                }
            },
            {
                "id": 2,
                "ulid": "01vvf062qevt1176yf7cgtk001",
                "status": true,
                "registration_number": "85631763583",
                "name": "Kiera Eli Fernandes",
                "email": "[e-mail]",
                "phone": "(00)00000-0000",
                "whatsapp": "(00)00000-0000",
                "bird_id": {
                    "is_valid": false,
                    "verified_at": "2024-04-23 15:09:50"
                },
                "videoconference": {
                    "verification": false,
                    "link": null
                }
            },
            {
                "id": 3,
                "ulid": "01vvf062poft1176yf7frdw008",
                "registration_number": "57606444242",
                "name": "Elizabeth Giovani Kerr",
                "email": "[e-mail]",
                "phone": "(00)00000-0000",
                "whatsapp": "(00)00000-0000",
                "bird_id": {
                    "is_valid": false,
                    "verified_at": "2024-04-23 15:09:50"
                },
                "videoconference": {
                    "verification": false,
                    "link": null
                }
            }
        ]
    }
}

401

403

404

No exemplo acima, estamos alterando alguns campos do cadastro da empresa do Cliente (estrutura "company"), estamos desativando o representante legal "Michael Keenan Franco" e estamos cadastrando uma nova representante legal chamada "Elizabeth Giovani Kerr" ao mesmo tempo. No retorno podemos perceber que já existia outra representante legal chamada "Kiera Eli Fernandes".

ALTERANDO O CADASTRO DA EMPRESA DO CLIENTE: Caso quisesse alterar somente os dados da empresa do Cliente, poderia omitir a estrutura "customers":[] e passar os campos que deseja alterar dentro da estrutura "company":

{
    "alias": "Barreto e Rodrigues e Filhos 2",
    "name": "Barreto e Rodrigues e Filhos 2",
    "email": "[e-mail]",
    "phone": "(87) 90410-25832",
    "whatsapp": "(22) 98676-25122",
    "country_id": 846,
    "state_id": 397,
    "city_id": 196,
    "address": "Largo Renan, 2. Bloco C",
    "number": "68111",
    "complement": "Bc. 8 Ap. 47",
    "neighborhood": "Sul",
    "postal_code": "95765-846"      
}

Neste caso, nada mudaria em relação ao cadastro do(s) representante(s) legal(is)

OBS: poderia omitir os campos que não deseja alterar.

CADASTRANDO UM NOVO REPRESENTANTE LEGAL: Caso quisesse incluir um novo Representante Legal, sem alterar nenhum dados do cadastro da empresa do Cliente "company", bastaria passar somente a estrutura "customers":

{  
  "customers": [       
        {
            "registration_number": "57606444242",
            "name": "Elizabeth Giovani Kerr",
            "email": "[e-mail]",
            "phone": "(00)00000-0000",
            "whatsapp": "(00)00000-0000"
        }
    ]
}

OBS: Note que é necessário que seja um array, sendo possível o cadastro de mais do que um representante ao mesmo tempo.

ALTERANDO UM REPRESENTANTE LEGAL CADASTRADO: Para alterar um representante legal cadastrado, basta passar os campos que deseja alterar dentro da estrutura "customers":[]. É necessário passar o "registration_number" (CPF) dele para que ele seja localizado e tenha o cadastro alterado, caso seja passado um "registration_number" (CPF) que ainda não esteja cadastrado, será feito um novo cadastro de alterar o existente:

{  
  "customers": [       
        {
            "registration_number": "57606444242",
            "name": "Elizabeth Giovani Kerr",
            "email": "[e-mail]",
            "phone": "(11)11111-5555",
            "whatsapp": "(00)00000-0000"
        }
    ]
}

OBS 1: Não precisa passar todos os campos, apenas o "registration_number" (para ele ser localizado) e o campo que deseja alterar.

OBS 2: Não é possível alterar o "registration_number" (CPF) pois caso seja um "registration_number" diferente, o sistema entende que é um cadastro novo.

OBS 3: Note que é necessário que seja um array, sendo possível a alteração e cadastro de mais do que um representante ao mesmo tempo.

Fluxograma do processo de alteração de cadastro do Cliente