Guides

Atualizar Participante do Contrato

Suggest Edits

Esse endpoint permite que você atualize dados de uma share específica.

PATCH /contracts/{contract_id}/shares/{sharing_id}

Testar endpoint

🚧

Todos os endpoints deverão ser autenticados

headers = {
  'Authorization': f'Bearer {api_key}',
  'Content-Type': 'application/json'
}
NameDescription
contract_idid do contrato
sharing_idid da share criada após a associação do participante ao contrato

⚠️ Lembre-se de substituir as variáveis no parâmetro da rota pelos valores corretos.

Exemplo de payload:

{
  "sharing": {
    "qualification": "Contratante",
    "party_id": 3056,
    "notification_type": "email"
  }
}

Descrição do payload:

NameTypeDescription
qualificationstringqualificação do participante em relação ao contrato (ex: "Testemunha", "Contratante", "Contratado", etc...)
party_idnumberid do participante pessoa física.
company_idnumber id da empresa associada ao contrato. (se houver)
notification_typestringtipo de notificação:

email - "email"
whatsapp - “whatsapp” (só será possível caso a organização tenha cotas de whatsapp contratada)

⚠️ Nesse endpoint será possível atualizar as informações de qualification de uma share especifica de um contrato, assim como trocar o participante. Caso queira acrescentar uma empresa na share anteriormente criada para associar uma pessoa física, será necessário passar o campo company_id no payload da requisição com o valor id da empresa.

Exemplo de resposta:

{
    "data": {
        "company": {
            "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": 346165,
            "address_state": "MG",
            "name": "Empresa do Davi",
            "national_id": null,
            "inserted_at": "2024-05-15T20:19:47",
            "birth_date": "1995-08-28",
            "contact_name": "Nome da pessoa responsável",
            "reps": [
                {
                    "trade_name": null,
                    "address_zip_code": null,
                    "form": null,
                    "document": "10872446840",
                    "reference": null,
                    "address_street": null,
                    "id": 3056,
                    "address_state": null,
                    "name": "Katia Fernanda Bastos",
                    "national_id": "21294731x",
                    "inserted_at": "2020-09-24T19:13:44",
                    "birth_date": null,
                    "contact_name": null,
                    "reps": null,
                    "organization": {
                        "id": 57
                    },
                    "updated_at": "2020-09-24T19:18:28",
                    "email": "[email protected]",
                    "address_complement": null,
                    "phone": null,
                    "contact_email": null,
                    "address_number": null,
                    "marital_status": null,
                    "address_neighborhood": null,
                    "state_subscription": null,
                    "person_type": "pf",
                    "contact_phone": null,
                    "imported_id": null,
                    "address_country": "BR",
                    "nationality": null,
                    "address_city": null,
                    "city_subscription": null,
                    "whatsappnum": null,
                    "profession": null
                }
            ],
            "organization": {
                "id": 1199
            },
            "updated_at": "2024-05-17T17:29:16",
            "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
        },
        "contract": {
            "id": 176022
        },
        "email_viewed_at": null,
        "engine": "standard",
        "id": 345652,
        "inserted_at": "2024-05-17T15:35:08",
        "notification_type": "email",
        "order": 1,
        "party": {
            "trade_name": null,
            "address_zip_code": null,
            "form": null,
            "document": "10872446840",
            "reference": null,
            "address_street": null,
            "id": 3056,
            "address_state": null,
            "name": "Katia Fernanda Bastos",
            "national_id": "21294731x",
            "inserted_at": "2020-09-24T19:13:44",
            "birth_date": null,
            "contact_name": null,
            "reps": null,
            "organization": {
                "id": 57
            },
            "updated_at": "2020-09-24T19:18:28",
            "email": "[email protected]",
            "address_complement": null,
            "phone": null,
            "contact_email": null,
            "address_number": null,
            "marital_status": null,
            "address_neighborhood": null,
            "state_subscription": null,
            "person_type": "pf",
            "contact_phone": null,
            "imported_id": null,
            "address_country": "BR",
            "nationality": null,
            "address_city": null,
            "city_subscription": null,
            "whatsappnum": null,
            "profession": null
        },
        "qualification": "Contratante",
        "signer_type": "sign",
        "updated_at": "2024-05-17T17:42:54",
        "viewed_at": null
    }
}

Updated 5 months ago