latestOpenAPI 3.1.02026-08-228421843.5 KB

6ad6c02e6af9

Activities

Update an activity

Updates a single activity by its activity_id or slug. The schema an activity extends is fixed after creation, so extends cannot be changed.

This endpoint is in alpha and may be subject to breaking changes as we gather feedback.

Required scopes: activity_configuration:read-write.

patch/v2/activities/{activity}

Path parameters

activitystring required

A UUID or slug to identify the activity.

Example:phone_calls

Request body

Example request

{
  "data": {
    "api_slug": "site_visits",
    "singular_noun": "Site visit",
    "plural_noun": "Site visits"
  }
}

Response

Success

Example response

{
  "data": {
    "id": {
      "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c",
      "activity_id": "97052eb9-e65e-443f-a297-f2d9a4a7f795"
    },
    "api_slug": "phone_calls",
    "singular_noun": "Phone call",
    "plural_noun": "Phone calls",
    "extends": [
      {
        "schema_id": "b1d6a29e-6f6f-4a0a-9b0e-59f0a3e3f7a1",
        "schema_slug": "calls"
      }
    ],
    "is_system_activity": true,
    "created_at": "2022-11-21T13:22:49.061281000Z"
  }
}