Create an event

POST /api/2.0/crm/history

Request

Creates an event with the parameters specified in the request.

Note: You must set a value for 'contactId' if 'entityId' is not set, or a values for the 'entityId' and 'entityType' parameters if 'contactId' is not set.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string: Can be one of: application/json.
Content-Typeenum of string: Can be one of: application/json.

Body

entityTypestring: Related entity type
entityIdinteger: Related entity ID
contactIdinteger: Contact ID
contentstring: Event contents
categoryIdinteger: Event category ID
createdstring: Event creation date
fileIdarray of integer: List of file IDs for the current event
notifyUserListarray of string: List of users who will be notified about the event

Examples

POST /api/2.0/crm/history HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request POST \
  --url https://example.com/api/2.0/crm/history \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Created event

CreateByobject

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

Createdstring

Contentstring

Categoryobject

ImagePathstring
Titlestring
Descriptionstring
Colorstring
SortOrderintegerformat: int32
IDintegerformat: int32

Contactobject

SmallFotoUrlstring

MediumFotoUrlstring

DisplayNamestring

IsCompanyboolean

AccessListarray of object

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

IsPrivateboolean

IsSharedboolean

ShareTypeenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read]

Can be one of: None, ReadWrite, Read.

Currencyobject

Titlestring
Symbolstring
Abbreviationstring
CultureNamestring
IsConvertableboolean
IsBasicboolean

CanEditboolean

CanDeleteboolean

IDintegerformat: int32

Entityobject

EntityTypestring
EntityIdintegerformat: int32
EntityTitlestring

CanEditboolean

Filesarray of object

Namestring

UpdatedByobject

Idstringformat: uuid
DisplayNamestring
Titlestring
AvatarSmallstring
ProfileUrlstring

Updatedstring

Locationstring