Skip to main content

​
PUT a Task

PUT /user-api/v1/tasks/:id

​
Headers

HeaderValue
Content-Typeapplication/json
x-rolodex-api-keyf1e2d3c4b5a697...

​
Path Parameters

​
id
string
Task ID

​
Query Parameters

​
include
string
Related data to include: tags

​
Endpoint Example

PUT /user-api/v1/tasks/task_99999?include=tags
Relationship fields (contacts, tags) are replaced entirely with the provided values. To add to existing relationships, include all current values plus new ones. Set assignee or creator to null to remove them.

​
Request (Mark as completed)

{
  "body": "Updated: Prepare quarterly business review presentation",
  "completed_at": "2025-01-20T14:30:00Z",
  "contacts": ["contact_123"],
  "tags": ["tag_101"]
}

​
Response

{
  "data": {
    "id": "task_99999",
    "body": "Updated: Prepare quarterly business review presentation",
    "due_date": "2025-01-25T16:00:00Z",
    "completed_at": "2025-01-20T14:30:00Z",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-20T14:30:00Z",
    "contacts": [
      {
        "id": "contact_123",
        "full_name": "John Doe",
        "image_url": "https://example.com/avatar.jpg"
      }
    ],
    "assignee": {
      "id": "user_456",
      "full_name": "Alice Smith",
      "avatar_url": "https://example.com/user-avatar.jpg"
    },
    "creator": {
      "id": "user_789",
      "full_name": "Bob Johnson",
      "avatar_url": "https://example.com/creator-avatar.jpg"
    }
  }
}