Update existing Custom Activity Type | Close | Developer API Documentation

curl -X PUT https://api.close.com/api/v1/custom_activity/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "fields": [
    {
      "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g"
    },
    {
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S"
    }
  ],
  "is_archived": true,
  "name": "Newsletter Signup"
}'

{
  "api_create_only": false,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "date_created": "2020-07-27T21:28:39.765523",
  "date_updated": "2020-08-07T16:23:36.429990",
  "editable_with_roles": [],
  "fields": [
    {
      "accepts_multiple_values": true,
      "editable_with_roles": [],
      "id": "cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g",
      "name": "Wants Marketing Materials",
      "required": false,
      "type": "choices"
    },
    {
      "accepts_multiple_values": false,
      "description": "Email of the person who signed up for the newsletter",
      "editable_with_roles": [],
      "id": "cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S",
      "name": "Email Address",
      "required": true,
      "type": "text"
    }
  ],
  "id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "is_archived": true,
  "name": "Newsletter Signup",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk"
}

The type’s name, description, api_create_only, editable_with_roles and is_archived may be updated here. These properties will be updated immediately in the Custom Activity API.

Field order can be set here, but adding, modifying or removing fields from a Custom Activity Type must be done using the Custom Field API. The field order is a display property only, and does not affect the request and response for the Custom Activity API.

The type's `name`, `description`, `api_create_only`, `editable_with_roles` and `is_archived` may be updated here. These properties will be updated immediately in the Custom Activity API. Field order can be set here, but adding, modifying or removing fields from a Custom Activity Type must be done using the Custom Field API. The field order is a display property only, and does not affect the request and response for the Custom Activity API.

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:)>.

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired

Request

This endpoint expects any.

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error