Update Record
Update fields on an existing record.
POST /v1/update-record
Update fields on an existing record. Only provide the fields you want to change — omitted fields are left unchanged. Use move-record instead to change which list a record is in.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
workspaceId | string | Yes | The workspace ID the record belongs to |
recordId | string | Yes | The record ID to update |
title | string | No | New title |
description | string | No | New description (plain text) |
descriptionHtml | string | No | New description as HTML. Sanitized server-side. Do not send with description. |
done | boolean | No | Set the done status. Pass true to mark as done, false to mark as not done. |
startedAt | string | No | Start date. Send a bare YYYY-MM-DD for an all-day date, or ISO 8601 for a timed one. |
duedAt | string | No | Due date. Send a bare YYYY-MM-DD for an all-day date, or ISO 8601 for a timed one. |
allDay | boolean | No | Force the dates to be all-day (a floating calendar date shown identically in every timezone) or timed. Usually unnecessary: bare YYYY-MM-DD dates are all-day automatically. |
color | string | No | Record color |
assigneeIds | string[] | No | User IDs to assign. Replaces all current assignees. |
{
"workspaceId": "string",
"recordId": "string",
"title": "string",
"description": "string",
"descriptionHtml": "string",
"done": true,
"startedAt": "string",
"duedAt": "string",
"allDay": true,
"color": "string",
"assigneeIds": [
"string"
]
}Response
Returns the result of the operation.
Example
curl -X POST https://rest.blue.app/v1/update-record \
-H "Authorization: Bearer $BLUE_TOKEN" \
-H "blue-org-id: $BLUE_ORG_ID" \
-H "Content-Type: application/json" \
-d '{"workspaceId":"string","recordId":"string","title":"string","description":"string","descriptionHtml":"string","done":true,"startedAt":"string","duedAt":"string","allDay":true,"color":"string","assigneeIds":["string"]}'