Criar Contrato
Agora, podemos criar um contrato de fato. Basta fazer uma requisição no endpoint de contracts.
POST /contracts
POST /contractsClique aqui para testar endpoint
Todos os endpoints deverão ser autenticados
headers = {
'Authorization': f'Bearer {api_key}',
'Content-Type': 'application/json'
}
⚠️ Para os endpoints que possuem payload, será necessário passar 'Content-Type': 'application/json' no headers da requisição.
Exemplo de payload:
{
"contract": {
"title": "Titulo do Contrato Teste",
"workflow_id": 2379,
"document": {
"file_id": 199849
}
"metadata": {
"criador": "Davi Ferreira",,
"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 em que o contrato será inserido |
| file_id * | number | id do arquivo que fará parte do documento principal do 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. |
🚨 Os campos marcados com * são obrigatórios.
⚠️ O file_id deverá receber o id do documento que teve seu upload realizado através do endpoint /files. Caso não tenho realizado esse processo, clique aqui para faze-lo antes de prosseguir.
Exemplo de resposta:
{
"data": {
"begin_date": null,
"due_notice": 60,
"observations": null,
"updated_at": "2025-05-13T20:58:45",
"needs_acceptance": false,
"metadata": {
"criador": "Davi Ferreira",
"data_criacao": "2025-05-12T10:00:00Z",
"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
}
}
⚠️ O id retornado nesse response será de suma importância para continuarmos o processo de disparo para assinaturas. O mesmo se encontra dento do objeto contract.
Updated 1 day ago