Updating a Custom Activity instance

PUT

https://api.close.com/api/v1/activity/custom/:id/

PUT

/api/v1/activity/custom/:id/

curl -X PUT https://api.close.com/api/v1/activity/custom/id/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "pinned": true,
  "status": "published",
  "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "thedarknight@close.com",
  "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": null
}'

{
  "_type": "CustomActivity",
  "activity_at": "2020-08-04T16:45:35.367000+00:00",
  "contact_id": null,
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "date_created": "2020-08-04T16:45:35.367000+00:00",
  "date_updated": "2020-08-04T17:37:56.439000+00:00",
  "id": "acti_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
  "last_published_at": "2020-08-04T16:45:35.367000+00:00",
  "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
  "mentions": [],
  "mentions_updated_at": null,
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "pinned": true,
  "pinned_at": "2020-08-04T17:37:56.439000+00:00",
  "source": "ui",
  "status": "published",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "user_id": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "users": [],
  "created_by_name": "Bruce Wayne",
  "updated_by_name": "Bruce Wayne",
  "user_name": "Bruce Wayne",
  "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "thedarknight@close.com"
}

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.

Authentication

AuthorizationBasic

Use your API key as the username and leave the password empty.

AuthorizationBearer

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

Path parameters

idstringRequired

Request

This endpoint expects an object.

activity_atdatetime or nullOptional

contact_idstring or nullOptional

pinnedboolean or nullOptional

statusenumOptional

Allowed values:

Response

Successful response

_typestring

activity_atdatetime or null

contact_idstring or null

created_bystring or null

custom_activity_type_idstring

date_createddatetime

date_updateddatetime

idstring

last_published_atdatetime or null

lead_idstring or null

mentionslist of strings

mentions_updated_atdatetime or null

organization_idstring

pinnedboolean

pinned_atdatetime or null

sourceenum or null

statusenum

Allowed values:

updated_bystring or null

user_idstring or null

userslist of strings

comment_summaryobject or nullOptional

created_by_namestring or nullOptional

updated_by_namestring or nullOptional

user_namestring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error