CLclose
activities.custom_activities

Updating a Custom Activity instance

Changed on

A Custom Activity can be updated to add, change or remove any Custom Fields and to change the status between "draft" and "published".

A Custom Activity can be pinned or unpinned by setting the pinned field to true or false when creating or updating a Custom Activity.

Custom Fields appear in the format: custom.{custom_field_id}. See Custom Fields.

put/activity/custom/{id}/

Request

  • Base URL
    https://api.close.com/api/v1
  • URL
    https://api.close.com/api/v1/activity/custom/{id}/
  • Auth
    • HTTP basic
    • or OAuth 2
      Authorization code: https://app.close.com/oauth2/authorize/
      Token URL: https://api.close.com/oauth2/token/

Path parameters

idstring required

Request body

activity_atstring date-time nullable
contact_idstring nullable
pinnedboolean nullable
status'draft' | 'published'

Response

Successful response

_typestring required
activity_atstring date-time nullable required
contact_idstring nullable required
created_bystring nullable required
created_by_agent_idstring nullable
created_by_namestring nullable
custom_activity_type_idstring required
date_createdstring date-time required
date_updatedstring date-time required
idstring required
last_published_atstring date-time nullable required
lead_idstring nullable required
mentionsstring[] required
mentions_updated_atstring date-time nullable required
organization_idstring required
pinnedboolean required
pinned_atstring date-time nullable required
source'ui' | 'api' | 'import' | 'clipper' | 'email' | 'suggestion' | 'segment-integration' | 'customerio-integration' | 'calendly-integration' | 'ai' | 'whatsapp' | 'webform' required
status'draft' | 'published' required
updated_bystring nullable required
updated_by_agent_idstring nullable
updated_by_namestring nullable
user_idstring nullable required
user_namestring nullable
usersstring[] required

Changes

  • 8e360c61058cRevision changes
    • info

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+$ to the response body for the status

  • 7bdb9cfcca22Revision changes
    • breaking

      added the pattern property ^custom\.(cf|lcf|ccf|acf|gcf|scf)_[A-Za-z0-9]+(\.(add|remove))?$ to the request body

    • info

      removed the pattern property ^custom\. from the request body