Guides

Atualizar Tarefa

Suggest Edits

Através desse endpoint vamos editar as informações de uma tarefa anteriormente criada.

PATCH /tasks/{task_id}

Clique aqui para testar endpoint

🚧

Todos os endpoints deverão ser autenticados

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

⚠️ Para editar uma tarefa, substitua o parâmetro da rota {task_id}, pelo valor id da tarefa em questão.

Exemplo de payload:

{ 
  "contract_task": { 
    "due_date": "2024-08-30", 
    "priority": 2, 
    "title": "Título da terefa", 
    "recurrence_count": "1", 
    "recurrence_frequency": "weekly", 
    "recurring": true, 
    "content": "descrição da tarefa", 
    "user_ids": ["user_id"]
  } 
}

Descrição do payload:

NameTypeDescription
due_datestringdata de vencimento da tarefa
prioritynumbernível de prioridade da tarefa, da seguinte forma:

1 – baixa;
2 - média;
3 – alta
titlestringtítulo da tarefa
recurrence_countstring repetir por tantas vezes, durante um período de tempo
recurrence_frequencystringa recorrência pode ser:

semanal - “weekly”
mensal – “monthly"
bimestral - “bimonthly”
trimestral- “quarterly”
anual – “annually”
recurringbooleana tarefa será recorrente? (Esse campo só pode ser enviado no payload, caso o due_date não seja vazio).
contentstringdescrição da tarefa
user_idsarray de stringsarray contendo os ids dos usuários que deverão ser notificados

Exemplo de resposta:

{
    "data": {
        "content": "descrição da tarefa",
        "contract": {
            "deny_reason": null,
            "status": {
                "id": 1640
            },
            "begin_date": "2024-05-12",
            "number": "2024/28",
            "workflow": null,
            "current_document": {
                "id": "c0444512-1d5b-40a7-9f4b-155a0ee71e38"
            },
            "classifier": null,
            "tasks": null,
            "archived": false,
            "due_notice": 7,
            "id": 176046,
            "shares": null,
            "inserted_at": "2024-05-23T20:13:07",
            "observations": null,
            "attachments": null,
            "financial": null,
            "form_submission": null,
            "organization": {
                "id": 1199
            },
            "object": null,
            "comments": null,
            "updated_at": "2024-05-29T13:53:23",
            "review_flows_events": null,
            "pendencies": 0.0,
            "assignee": {
                "id": 3056
            },
            "title": "Teste Contrato",
            "term_type": "Indeterminado",
            "deleted": false,
            "needs_acceptance": false,
            "end_date": "2024-05-30",
            "childrem_contracts": null,
            "prev_status": null,
            "custom_fields": null,
            "parent_contract": null,
            "review_flow": null,
            "prev_assignee": null
        },
        "done": false,
        "due_date": "2024-08-30",
        "id": 1126,
        "inserted_at": "2024-05-29T14:24:02",
        "priority": 2,
        "progress": {},
        "recurrence_count": 1,
        "recurrence_frequency": "weekly",
        "recurring": true,
        "requester": {
            "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": "Título da terefa",
        "updated_at": "2024-05-29T14:37:08",
        "user_ids": [
            3056
        ],
        "users": [
            {
                "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
            }
        ]
    }
}

Updated 3 months ago