Email SupportCall Us Go to Close

Activity Custom Fields

List all the Activity Custom Fields for your organization.

GET /custom_field/activity/

Create a new Activity Custom Field.

POST /custom_field/activity/

Activity Custom Fields belong to Custom Activities, and have additional attributes:

  • custom_activity_type_id – the ID of the Custom Activity Type this Field should belong to.
  • required – whether the Field will be requied to publish the activity.

Fetch Activity Custom Field's details.

GET /custom_field/activity/{id}/

Update an Activity Custom Field.

PUT /custom_field/activity/{custom_field_id}/

You can rename it, change whether it accepts multiple values or not, change the "required" flag, change whether editing its values is restricted to specific Roles, or update the options for a "choices" field type. The updated name will immediately appear in the Close UI and only valid values for the updated type will be returned by the Custom Activity API.

The custom_activity_type_id and type values cannot be changed.

Delete an Activity Custom Field.

DELETE /custom_field/activity/{custom_field_id}/

The field will immediately disappear from any Custom Activity API responses.