v1

latestOpenAPI 3.0.22026-08-045831103.6 KB

Activities

Update activity

Update one or more fields of an activity. At least one of title, type, content, template_id, due_at, or stage_id is required. stage_id must be a stage belonging to the deal's origin. template_id is only supported for WHATSAPP activities (pass null to detach). Requires the ACTIVITIES_API feature flag and an API key with the activities:write scope. Only activities belonging to the authenticated owner can be updated.

post/v2/activities/{id}

Path parameters

idstring uuid required

Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

UUID

Headers

api-tokenstring required

API Token

Request body

titlestring

contentstring nullable

Free-text body. For WHATSAPP/INSTAGRAM this is the message text; for CALL/MAIL/TASK it is the notes field.

template_idstring uuid nullable

Attach (UUID) or detach (null) a WhatsApp Official message template. Only supported when the activity type is WHATSAPP; must reference a template belonging to the authenticated owner.

due_atstring date-time nullable

stage_idstring uuid

Example request

{
  "title": "Call the customer back tomorrow",
  "type": "CALL",
  "content": "Updated notes.",
  "template_id": "b3c2d1e0-1234-4abc-9def-0123456789ab",
  "due_at": "2024-01-21T14:00:00.000Z",
  "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8"
}

Response

The updated activity object

statusinteger

Response status

Example response

{
  "status": 200,
  "data": {
    "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "title": "Call the customer back",
    "type": "CALL",
    "content": "Discuss the renewal proposal.",
    "due_at": "2024-01-20T14:00:00.000Z",
    "custom": true,
    "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "created_at": "2020-01-01T14:15:00.000000+00:00",
    "deal": {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "status": "OPEN",
      "origin_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "contact": {
        "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
        "name": "Jane Doe"
      }
    }
  }
}