Atualizar Contrato

Esse endpoint permite que você atualize dados de um contrato através do seu id.

`PATCH` /contracts/{contract_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 {contract_id} no parâmetro da rota pelo valor id do contrato que você deseja editar.

Exemplo de payload:

{ 
  "contract": { 
    "title": "Contrato Teste API", 
    "workflow_id": workflow_id, 
    "status_id": 1638,
    "assignee_id": "318983",
    "object": "Insira aqui um resumo sobre a contratação",
    "observations": "Insira informações importantes acerca do contrato que não estão nos demais campos",
    "classifier": ["Fornecedores"],
    "archived": false,
    "deleted": false,
    "metadata": {
        "criador": "Davi Ferreira",
        "email": "[email protected]",
        "data_criacao": "2025-05-12T10:00:00Z",
        "versao": "v.1.8",
        "ambiente": "produção"
    }
  } 
}

Descrição do payload:

Name	Type	Description
title	string	título do contrato
workflow_id	number	id do grupo de trabalho ao qual você quer associar seu contato
status_id	number	id do status em que o contrato se encontra: 1638 - Rascunho 1639 - Aguardando Revisão 1640 - Aguardando Assinatura 1641 - Vigente 1642 - Encerrado
assignee_id	string	id do responsável pelo contrato
object	string	resumo sobre a contratação
observations	string	informações importantes acerca do contrato que não estão nos demais campos
classifier	array de strings	array de strings com a classificação de acordo com a natureza do contrato. Ex: Fornecedores, Clientes, Societário.
archived	boolean	true para arquivar o contrato
deleted	boolean	true para deletar o contrato
metadata	object	objeto onde poderá conter chaves e valores em strings sobre dados relevantes em relação ao contrato. O objeto é livre para ser manipulado da maneira que o usuário achar melhor.

Exemplo de resposta:

{
    "data": {
        "begin_date": null,
        "due_notice": 60,
        "observations": null,
        "updated_at": "2025-05-13T20:58:45",
        "needs_acceptance": false,
        "metadata": {
            "ambiente": "produção",
            "criador": "Davi Ferreira",
            "data_criacao": "2025-05-12T10:00:00Z",
            "email": "[email protected]",
            "versao": "v.1.8"
        },
        "status": {
            "color": 1,
            "id": 10517,
            "name": "Rascunho"
        },
        "comments": [],
        "review_flows_events": [],
        "deny_reason": null,
        "inserted_at": "2025-05-13T20:58:45",
        "shares": [],
        "form_submission": null,
        "parent_contract": null,
        "id": 3616045,
        "archived": false,
        "object": null,
        "title": "Teste Whatsapp Sandbox",
        "assignee": {
            "activated": true,
            "activity": "Dev Fullstack ",
            "cpf": "050.934.369-41",
            "email": "[email protected]",
            "first_name": "Demetrius",
            "gender": "unspecified",
            "id": 858930,
            "last_name": "Mânica",
            "marital_status": null,
            "organizations_users": null
        },
        "review_flow": null,
        "childrem_contracts": [],
        "tasks": [],
        "prev_assignee": null,
        "deleted": false,
        "current_document": {
            "contract": {
                "id": 3616045
            },
            "draft": null,
            "editor": "tinymce",
            "file": {
                "download_url": "url de download",
                "google_file_id": null,
                "id": 16668319,
                "inserted_at": "2025-05-13T20:53:58",
                "mime": "application/pdf",
                "name": "dummy.pdf",
                "preview_url": "url de preview",
                "size": 13264,
                "updated_at": "2025-05-13T20:53:58"
            },
            "id": "946a4193-f4fb-4d3b-aee9-572fab13925a",
            "inserted_at": "2025-05-13T20:58:45",
            "notes": null,
            "organization": {
                "id": 5515
            },
            "proofs": [],
            "updated_at": "2025-05-13T20:58:45",
            "user": {
                "id": 858930
            }
        },
        "term_type": null,
        "prev_status": null,
        "number": "2025/11",
        "organization": {
            "active": true,
            "addons": [],
            "available_proof_engines": [
                "standard",
                "standard_rubric"
            ],
            "domains": [],
            "id": 5515,
            "inserted_at": "2024-07-04T17:45:56",
            "logo_url": null,
            "name": "Deme Dev",
            "organization_plan": {
                "document_history": false,
                "form_review_flow": false,
                "id": 5468,
                "inserted_at": "2024-07-04T17:45:56",
                "organization": {
                    "id": 5515
                },
                "plan": {
                    "id": 4
                },
                "price": "2500",
                "price_user": "56.33",
                "redlining": false,
                "sharelink": true,
                "signature_counter": 1,
                "updated_at": "2024-12-05T19:45:21",
                "whatsapp_link": true,
                "whatsapp_monthly_quota": 1000,
                "whatsapp_notification": true
            },
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2025-05-13T20:58:45",
            "workflows": null
        },
        "pendencies": 0,
        "end_date": null,
        "financial": [],
        "attachments": [],
        "workflow": null,
        "custom_fields": [],
        "classifier": null
    }
}

PATCH /contracts/{contract_id}

🚧Todos os endpoints deverão ser autenticados

Exemplo de payload:

Descrição do payload:

Exemplo de resposta:

`PATCH` /contracts/{contract_id}

🚧
Todos os endpoints deverão ser autenticados