Activity

An acitivity is something that has happened to a contact, such as a booking, purchase, or interaction. Activities are used to track the history of a contact and can be used to trigger automations or workflows. Activities can be created manually or automatically by the system. Each activity is associated with a contact and has a type, source, and date it happened, some acitivities may also have a booking or purchase associated with them.

List all activities

get

Returns a list of activities across all contacts. The activities are ordered by the date they happened, with the most recent first.

Authorizations
x-api-keystringRequired

Value for the x-api-key header parameter.

Query parameters
pageintegerOptional

The collection page number

Default: 1
happenedAt[before]stringOptional
happenedAt[strictly_before]stringOptional
happenedAt[after]stringOptional
happenedAt[strictly_after]stringOptional
createdAt[before]stringOptional
createdAt[strictly_before]stringOptional
createdAt[after]stringOptional
createdAt[strictly_after]stringOptional
updatedAt[before]stringOptional
updatedAt[strictly_before]stringOptional
updatedAt[after]stringOptional
updatedAt[strictly_after]stringOptional
typestring · enumOptionalPossible values:
Responses
200

Activity collection

get
/activities

Create an activity

post

Creates a new activity for a contact.

Authorizations
x-api-keystringRequired

Value for the x-api-key header parameter.

Body

An acitivity is something that has happened to a contact, such as a booking, purchase, or interaction. Activities are used to track the history of a contact and can be used to trigger automations or workflows. Activities can be created manually or automatically by the system. Each activity is associated with a contact and has a type, source, and date it happened, some acitivities may also have a booking or purchase associated with them.

idintegerRead-onlyOptional
contactstring · iri-referenceOptionalExample: https://example.com/
happenedAtstring · date-timeOptional
typestring · enumOptionalPossible values:
sourcestringOptional
bookingstring | nullOptionalExample: https://example.com/
externalReferencestringOptionalDefault: ""
purchasestring | nullOptionalExample: https://example.com/
spendintegerOptionalDefault: 0
giftCardstring | nullOptionalExample: https://example.com/
currencyCodestring | nullOptional
Responses
post
/activities

Retrieve an activity

get

Retrieves a Activity resource.

Authorizations
x-api-keystringRequired

Value for the x-api-key header parameter.

Path parameters
idstringRequired

Activity identifier

Responses
200

Activity resource

get
/activities/{id}

Last updated