Create a new Custom Activity instance

POST

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

POST

/api/v1/activity/custom/

$ 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"
> }'

1 {
2   "_type": "CustomActivity",
3   "activity_at": "2020-08-04T16:45:35.367000+00:00",
4   "contact_id": null,
5   "created_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
6   "custom_activity_type_id": "actitype_1h5m6uHM9BZOpwVhyRJb4Y",
7   "date_created": "2020-08-04T16:45:35.367000+00:00",
8   "date_updated": "2020-08-04T17:37:56.439000+00:00",
9   "id": "acti_5J7mimiIKB1tQ3gVduP0c4UhXbNj5ptMLteAWRJu7Sf",
10   "last_published_at": "2020-08-04T16:45:35.367000+00:00",
11   "lead_id": "lead_hwnL36A2iEMSLIlmGhsdrcmOJzTUzqEHwr66wrA1K2T",
12   "mentions": [],
13   "mentions_updated_at": null,
14   "organization_id": "orga_RbREgmiiwcr1w2b4cOnCMQaQPSIFxMqAD2Dh243uxcH",
15   "pinned": true,
16   "pinned_at": "2020-08-04T17:37:56.439000+00:00",
17   "source": "ui",
18   "status": "published",
19   "updated_by": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
20   "user_id": "user_Ova4RGFG7pztSeJiiMFdN7O2MFl71nD0uGO3bIOo4Wk",
21   "users": [],
22   "created_by_name": "Bruce Wayne",
23   "updated_by_name": "Bruce Wayne",
24   "user_name": "Bruce Wayne",
25   "custom.cf_UpyNBvr6Rw8UBHh7zRboL3PYhbOVJl3XvwgPm3jg64S": "thedarknight@close.com",
26   "custom.cf_cSh3fWT3rEJ1BFSezme2YAG6bPrZV5wUWKKrW4iN19g": "Yes"
27 }

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.

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

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. Custom Fields appear in the format: `custom.{custom_field_id}`. See [Custom Fields](https://developer.close.com/api/resources/custom-fields/custom-fields-activity).

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.

Request

This endpoint expects an object.

custom_activity_type_idstringRequired

lead_idstringRequired

activity_atdatetime or nullOptional

contact_idstring or nullOptional

created_bystring or nullOptional

date_createddatetime or nullOptional

organization_idstring or nullOptional

pinnedboolean or nullOptional

statusenumOptional

user_idstring or nullOptional

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

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