Guides

Atualizar Participante

Suggest Edits

Esse endpoint permite que você atualize dados de uma pessoa física ou uma pessoa jurídica através do seu id.

PATCH /parties/{party_id}

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}

⚠️ Lembre-se de substituir a variável {party_id} no parâmetro da rota pelo valor id da pessoa que você deseja editar.


Participante Pessoa Física:

Primeiramente, vamos editar os dados de um participante pessoa física.

Testar endpoint

Exemplo de payload:

{ 
  "party": { 
    "name": "Seu nome editado aqui", 
    "email": "[email protected]",
    "document": "285.946.130-24",
    "national_id": "99999999",
    "birth_date": "1997-08-28",
    "marital_status": "single",
    "nationality": "Brasileiro",
    "profession": "Dev",
    "address_zip_code": "36406-000",
    "address_street": "Av Car",
    "address_number": "25",
    "address_neighborhood": "Centro",
    "address_complement": "Complemento do endereço",
    "address_city": "Belo Horizonte",
    "address_state": "MG",
    "address_country": "Brasil",
    "reference": "Praça da liberdade",
    "phone": "(31) 99999-9999",
    "whatsappnum": "+55 31 99999 9999"
  } 
}

Descrição do payload:

NameTypeDescription
name stringnome da pessoa física
email stringemail da pessoa física
documentstringCPF
national_idstringRG
birth_datestringdata de nascimento
marital_statusstringsolteiro - "single",
casado - "married",
divorciado - "divorced"
viúvo - "widower"
nationalitystringnacionalidade
professionstringprofissão
address_zip_codestringCEP
address_streetstringnome da rua
address_numberstringnúmero da residência
address_neighborhoodstringbairro
address_complementstringcomplemento do endereço
address_citystringcidade
address_statestringestado
address_countrystringpaís
referencestringreferência do endereço
phonestringtelefone da pessoa física
whatsappnumstringwhatsapp da pessoa física

Exemplo de resposta:

{
    "data": {
        "trade_name": null,
        "address_zip_code": "36406-000",
        "form": null,
        "document": "285.946.130-24",
        "reference": "Praça da liberdade",
        "address_street": "Av Car",
        "id": 346155,
        "address_state": "MG",
        "name": "Seu nome editado aqui",
        "national_id": "99999999",
        "inserted_at": "2024-05-14T16:11:45",
        "birth_date": "1997-08-28",
        "contact_name": null,
        "reps": [
            {
                "trade_name": null,
                "address_zip_code": "36406-007",
                "form": null,
                "document": "136.382.516-08",
                "reference": "Praça da liberdade",
                "address_street": "Av Car",
                "id": 346155,
                "address_state": "MG",
                "name": "Seu nome aqui",
                "national_id": "20017630",
                "inserted_at": "2024-05-14T16:11:45",
                "birth_date": "1997-08-28",
                "contact_name": null,
                "reps": null,
                "organization": {
                    "id": 1199
                },
                "updated_at": "2024-05-14T16:36:00",
                "email": "[email protected]",
                "address_complement": "Complemento do endereço",
                "phone": "(31) 98700-1467",
                "contact_email": null,
                "address_number": "25",
                "marital_status": "single",
                "address_neighborhood": "Centro",
                "state_subscription": null,
                "person_type": "pf",
                "contact_phone": null,
                "imported_id": null,
                "address_country": "Brasil",
                "nationality": "Brasileiro",
                "address_city": "Belo Horizonte",
                "city_subscription": null,
                "whatsappnum": "+55 31 98700 1467",
                "profession": "Dev"
            }
        ],
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-09T19:04:58",
            "workflows": null
        },
        "updated_at": "2024-05-14T16:37:19",
        "email": "[email protected]",
        "address_complement": "Complemento do endereço",
        "phone": "(31) 99999-9999",
        "contact_email": null,
        "address_number": "25",
        "marital_status": "single",
        "address_neighborhood": "Centro",
        "state_subscription": null,
        "person_type": "pf",
        "contact_phone": null,
        "imported_id": null,
        "address_country": "Brasil",
        "nationality": "Brasileiro",
        "address_city": "Belo Horizonte",
        "city_subscription": null,
        "whatsappnum": "+55 31 99999 9999",
        "profession": "Dev"
    }
}

PATCH /parties/{company_id}


Participante pessoa jurídica:

Agora vamos editar os dados de um participante pessoa jurídica.

Testar endpoint

⚠️ Lembre-se de substituir a variável {company_id} no parâmetro da rota pelo valor id da empresa que você deseja editar.

Exemplo de payload:

{ 
  "party": { 
    "name": "Razão social da empresa editado", 
    "trade_name": "Nome fantasia da empresa editado",
    "contact_email": "[email protected]",
    "contact_name": "Nome da pessoa responsável",
    "contact_phone": "(31) 99999-9999",
    "document": "22.516.356/0001-15",
    "state_subscription": "843.774.723/9603",
    "city_subscription": "843.774.723/9603",
    "birth_date": "1997-08-28",
    "address_zip_code": "36406-006",
    "address_street": "Av Car",
    "address_number": "25",
    "address_neighborhood": "Centro",
    "address_complement": "Complemento do endereço",
    "address_city": "Belo Horizonte",
    "address_state": "MG",
    "address_country": "Brasil",
    "reference": "Praça da liberdade",
    "phone": "(31) 99999-9999",
    "whatsappnum": "+55 31 99999 9999"
  } 
}

Descrição do payload:

NameTypeDescription
namestringrazão social da empresa
trade_namestringnome fantasia da empresa
contact_emailstringemail da pessoa responsável
contact_namestringnome da pessoa responsável
contact_phonestringtelefone da pessoa responsável
documentstringCNPJ
state_subscriptionstringinscrição estadual
city_subscriptionstringinscrição municipal
birth_datestringdata de criação da empresa
address_zip_codestringCEP
address_streetstringendereço da empresa
address_numberstringnúmero do endereço
address_neighborhoodstringbairro
address_complementstringcomplemento do endereço
address_citystringcidade
address_statestringestado
address_countrystringpaís
referencestringreferência do endereço
phonestringtelefone da empresa
whatsappnumstringwhatsapp da empresa

Exemplo de resposta:

{
    "data": {
        "trade_name": "Nome fantasia da empresa editado",
        "address_zip_code": "36406-006",
        "form": null,
        "document": "22.516.356/0001-15",
        "reference": "Praça da liberdade",
        "address_street": "Av Car",
        "id": 346154,
        "address_state": "MG",
        "name": "Razão social da empresa editado",
        "national_id": null,
        "inserted_at": "2024-05-14T15:27:34",
        "birth_date": "1997-08-28",
        "contact_name": "Nome da pessoa responsável",
        "reps": [
            {
                "trade_name": "Nome fantasia da empresa editado",
                "address_zip_code": "36406-006",
                "form": null,
                "document": "22.516.356/0001-15",
                "reference": "Praça da liberdade",
                "address_street": "Av Car",
                "id": 346154,
                "address_state": "MG",
                "name": "Razão social da empresa editado",
                "national_id": null,
                "inserted_at": "2024-05-14T15:27:34",
                "birth_date": "1997-08-28",
                "contact_name": "Nome da pessoa responsável",
                "reps": null,
                "organization": {
                    "id": 1199
                },
                "updated_at": "2024-05-14T16:33:38",
                "email": null,
                "address_complement": "Complemento do endereço",
                "phone": "(31) 98700-1467",
                "contact_email": "[email protected]",
                "address_number": "25",
                "marital_status": null,
                "address_neighborhood": "Centro",
                "state_subscription": "843.774.723/9603",
                "person_type": "pj",
                "contact_phone": "(31) 99999-9999",
                "imported_id": null,
                "address_country": "Brasil",
                "nationality": null,
                "address_city": "Belo Horizonte",
                "city_subscription": "843.774.723/9603",
                "whatsappnum": "+55 31 98700 1467",
                "profession": null
            }
        ],
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard"
            ],
            "domains": [],
            "id": 1199,
            "inserted_at": "2023-12-15T19:35:45",
            "logo_url": null,
            "name": "CK API Development Corp",
            "organization_plan": null,
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-09T19:04:58",
            "workflows": null
        },
        "updated_at": "2024-05-14T16:42:52",
        "email": null,
        "address_complement": "Complemento do endereço",
        "phone": "(31) 99999-9999",
        "contact_email": "[email protected]",
        "address_number": "25",
        "marital_status": null,
        "address_neighborhood": "Centro",
        "state_subscription": "843.774.723/9603",
        "person_type": "pj",
        "contact_phone": "(31) 99999-9999",
        "imported_id": null,
        "address_country": "Brasil",
        "nationality": null,
        "address_city": "Belo Horizonte",
        "city_subscription": "843.774.723/9603",
        "whatsappnum": "+55 31 99999 9999",
        "profession": null
    }
}


Como editar um participante

Acesse nossa central de ajuda e veja o passo a passo completo:

Como corrigir dados após o pedido de assinatura

Updated 3 months ago