Guides

Atualizar Contrato

Suggest Edits

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

PATCH /contracts/{contract_id}

Clique aqui para testar endpoint

🚧

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
  } 
}

Descrição do payload:

NameTypeDescription
titlestringtítulo do contrato
workflow_idnumberid do grupo de trabalho ao qual você quer associar seu contato
status_idnumberid do status em que o contrato se encontra:
1638 - Rascunho
1639 - Aguardando Revisão
1640 - Aguardando Assinatura
1641 - Vigente
1642 - Encerrado
assignee_idstringid do responsável pelo contrato
objectstringresumo sobre a contratação
observationsstringinformações importantes acerca do contrato que não estão nos demais campos
classifierarray de stringsarray de strings com a classificação de acordo com a natureza do contrato. Ex: Fornecedores, Clientes, Societário.
archivedbooleantrue para arquivar o contrato
deletedbooleantrue para deletar o contrato

Exemplo de resposta:

{
    "data": {
        "deny_reason": null,
        "status": {
            "color": 1,
            "id": 1638,
            "name": "Rascunho"
        },
        "begin_date": null,
        "number": "2024/22",
        "workflow": null,
        "current_document": {
            "contract": {
                "id": 176021
            },
            "draft": null,
            "editor": "tinymce",
            "file": {
                "download_url": url de download do arquivo,
                "google_file_id": null,
                "id": 199840,
                "inserted_at": "2024-05-13T16:46:42",
                "mime": "application/pdf",
                "name": "dummy.pdf",
                "preview_url": url de visualização prévia do arquivo,
                "size": 13264,
                "updated_at": "2024-05-13T16:46:42"
            },
            "id": "06353f3b-3c94-4a46-a708-813e9e742f71",
            "inserted_at": "2024-05-15T16:01:15",
            "notes": null,
            "organization": {
                "id": 1199
            },
            "proofs": [],
            "updated_at": "2024-05-15T16:01:15",
            "user": {
                "id": 3056
            }
        },
        "classifier": [
            "Fornecedores"
        ],
        "tasks": [],
        "archived": false,
        "due_notice": 60,
        "id": 176021,
        "shares": [],
        "inserted_at": "2024-05-15T16:01:15",
        "observations": "Insira informações importantes acerca do contrato que não estão nos demais campos",
        "attachments": [],
        "financial": [],
        "form_submission": 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": {
                "document_history": false,
                "form_review_flow": false,
                "id": 1193,
                "inserted_at": "2023-12-15T19:35:45",
                "organization": {
                    "id": 1199
                },
                "plan": {
                    "id": 7
                },
                "price": "199.90",
                "price_user": "56.33",
                "redlining": false,
                "sharelink": false,
                "signature_counter": 1,
                "updated_at": "2023-12-15T19:35:45",
                "whatsapp_link": false,
                "whatsapp_monthly_quota": 0,
                "whatsapp_notification": false
            },
            "organizations_users": null,
            "statuses": null,
            "updated_at": "2024-05-15T16:01:15",
            "workflows": null
        },
        "object": "Insira aqui um resumo sobre a contratação",
        "comments": [],
        "updated_at": "2024-05-15T16:01:38",
        "review_flows_events": [],
        "pendencies": 0,
        "assignee": {
            "activated": true,
            "activity": "Desenvolvedor Jr",
            "cpf": "136.382.516-08",
            "email": "[email protected]",
            "first_name": "Davi",
            "gender": "unspecified",
            "id": 3056,
            "last_name": "Ferreira",
            "marital_status": null,
            "organizations_users": null
        },
        "title": "Contrato Teste API",
        "term_type": null,
        "deleted": false,
        "needs_acceptance": false,
        "end_date": null,
        "childrem_contracts": [],
        "prev_status": null,
        "custom_fields": [],
        "parent_contract": null,
        "review_flow": null,
        "prev_assignee": null
    }
}

Updated 3 months ago