Actualizar tarea

PATCHhttps://api.bydomu.com/v1/tasks/{id}

Esta referência é gerada a partir do código da API, por isso as descrições estão em espanhol. Nomes, parâmetros e exemplos são iguais em qualquer idioma.

Actualiza solo los campos enviados. Cerrar una tarea es enviar status: "COMPLETED".

Permissão
tasks:write
Chaves
Só secreta (de um servidor)

Cabeçalhos

X-API-Keystringobrigatório
Sua chave secreta.
Idempotency-Keystring
Clave única de la operación (8-128 caracteres de [a-zA-Z0-9._:-]). Un reintento con la misma clave y el mismo cuerpo devuelve la respuesta original sin repetir la operación. Vive 24 horas. · 8–128 chars

Parâmetros de rota

idstringobrigatório
ID de la tarea

Corpo (JSON)

titlestring
2–200 chars
descriptionstring
≤ 2000 chars · nullable
typestring
CALLEMAILWHATSAPPVISITMEETINGSEND_PROPOSALSEND_CONTRACTFOLLOW_UPSCHEDULE_SHOWINGCOLLECT_DOCUMENTSOTHER
statusstring
PENDINGIN_PROGRESSCOMPLETEDCANCELLEDOVERDUE
prioritystring
LOWMEDIUMHIGHURGENT
dueDatestring
nullable
assigneeIdstring
attachmentsobject[]

Respostas

200Tarea actualizada
400Datos inválidos: el cuerpo o la query no cumplen el esquema, o `Idempotency-Key` está mal formada.
401UNAUTHORIZED · Clave faltante, inválida, desactivada o vencida.
402PAYMENT_REQUIRED · Cuenta en modo solo lectura: se rechaza toda mutación.
403FORBIDDEN · La clave no puede usar esta operación: falta el scope, es una secreta en el navegador, el nivel de la cuenta no la permite, está suspendida o se alcanzó un tope del plan.
404NOT_FOUND · El recurso no existe en la organización.
409DUPLICATE · Choca con un dato existente o con el estado actual, o la `Idempotency-Key` ya se usó con otro cuerpo o sigue en curso.
429RATE_LIMITED · Límite de peticiones excedido: el de la clave (`RATE_LIMITED`), el de escrituras de la organización (`TENANT_RATE_LIMITED`) o bloqueo temporal de la IP por claves inválidas.
500INTERNAL_ERROR · Error interno del servidor.
cURL
curl -X PATCH "https://api.bydomu.com/v1/tasks/clx1tsk001" \
  -H "X-API-Key: $BYDOMU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "COMPLETED"
}'
JavaScript
const res = await fetch("https://api.bydomu.com/v1/tasks/clx1tsk001", {
  method: "PATCH",
  headers: {
    "X-API-Key": process.env.BYDOMU_API_KEY,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "status": "COMPLETED"
  }),
});
const data = await res.json();
Python
import os, requests

r = requests.patch(
    "https://api.bydomu.com/v1/tasks/clx1tsk001",
    headers={"X-API-Key": os.environ["BYDOMU_API_KEY"]},
    json={
        "status": "COMPLETED"
    }
)
data = r.json()
Resposta · 200 · exemplo
{
  "data": {
    "id": "clx1tsk001",
    "title": "Llamar a María para confirmar la visita",
    "description": "Confirmar el jueves a las 10.",
    "type": "CALL",
    "status": "PENDING",
    "priority": "LOW",
    "dueDate": "2026-10-01T15:00:00.000Z",
    "completedAt": "2026-10-01T14:40:00.000Z",
    "archivedAt": "2026-10-15T00:00:00.000Z",
    "attachments": [],
    "dealId": "clx1deal001",
    "contactId": "clx1con001",
    "assigneeId": "clx1usr001",
    "createdById": "clx1usr002",
    "createdAt": "2026-09-25T10:00:00.000Z",
    "updatedAt": "2026-09-25T10:00:00.000Z",
    "assignee": {
      "id": "clx1usr001",
      "firstName": "Carlos",
      "lastName": "Rodríguez"
    },
    "createdBy": {
      "id": "clx1usr001",
      "firstName": "Carlos",
      "lastName": "Rodríguez"
    }
  }
}

A chave vai na variável BYDOMU_API_KEY. Os dados do exemplo não são de nenhuma imobiliária.