v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Contacts

Create Contact Activity

Adds an activity relating to the contact. The added activity is displayed on the Activities tab of the contact profile page.

post/v1/contact/{contactId}/activity

Path parameters

contactIdstring required

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Request body

typeIdinteger required

The identifier for the activity type.

namestring

The name of the activity type.

show_ininteger

An indicator of which activity type group the current activity type should be included in. Allowed values: -2 for Archived Activities/Tasks, -1 for All Activities/Tasks, 0 for Custom Tasks/Activities, 1 for Activities, 2 for Tasks. A value of -2 cannot be submitted when creating an activity.

activityDatestring date-time

The date of the activity.

contactIdinteger

The identifier for the contact who logged the activity.

idinteger

The identifier for the contact activity.

notesstring

Notes on the contact activity.

userIdinteger

The identifier for the user who created the activity.

contactActivityDetailsDefinitionIdsinteger[]

The list of identifiers for the contact activity details definitions associated with the activity.

Example request

{
  "typeId": 284,
  "name": "Interview completed",
  "show_in": 1
}

Response

The contact activity that was created.