Create a new Custom Activity instance | Close

curl -X POST https://api.close.com/api/v1/activity/custom/ \
     -H "Content-Type: application/json" \
     -u "<CLOSE_API_KEY>:" \
     -d '{
  "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
  "lead_id": "lead_p9bdo1sTVDvc81drMF1IxJBSHiLFZqaABYRu7ZHuxhP",
  "pinned": true,
  "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "thedarknight@close.com",
  "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Yes"
}'

{
  "_type": "CustomActivity",
  "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "created_by_name": "Bruce Wayne",
  "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "thedarknight@close.com",
  "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Yes",
  "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",
  "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
  "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
  "pinned": true,
  "pinned_at": "2020-08-04T17:37:56.439000+00:00",
  "status": "published",
  "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "updated_by_name": "Bruce Wayne",
  "user_id": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
  "user_name": "Bruce Wayne",
  "users": []
}

Custom Activity instances will be created by default with the ‘published’ status. All required fields will be validated in this status. To create an activity without setting all required fields, you can use the “draft” status.

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

Authentication

AuthorizationBasic

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

AuthorizationBearer

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

Request

This endpoint expects an object.

custom_activity_type_idstringRequired

lead_idstringRequired

activity_atdatetime or nullOptional

contact_idstring or nullOptional

created_by_idstring or nullOptional

custom_fieldsmap from strings to any or nullOptional

date_createddatetime or nullOptional

organization_idstring or nullOptional

pinnedboolean or nullOptional

statusenumOptional

Allowed values:

user_idstring or nullOptional

Response

Successful response

Errors

400

Bad Request Error

401

Unauthorized Error

404

Not Found Error