Skip to content
Home/
REST API Reference
/
/
Contact Activity

Contact Activity

An activity event that occurred for a contact, such as creation, merge, or deletion.

typestring

Always contact_activity

Value:"contact_activity"
Example:"contact_activity"
idstring

The unique identifier for the activity event.

Example:"1717000000000.0000a1"
event_typestring

The type of activity event.

Enum:"contact.created""contact.role_updated""contact.deleted""contact.merged""contact.merge_failed"
Example:"contact.created"
contact_idstring

The unique identifier for the contact the event relates to.

Example:"6329bd9ffe4e2e91dc5d6a1e"
external_idstring or null

The external identifier of the contact, if one is set.

Example:"user-42"
rolestring or null

The role of the contact at the time of the event, either user, lead, or visitor.

Example:"user"
merge_source_idstring or null

For merge events, the identifier of the contact that was merged away.

Example:"5f7f0d217c3f2e001a4e8b12"
merge_target_idstring or null

For merge events, the identifier of the contact that was merged into.

Example:"6329bd9ffe4e2e91dc5d6a1e"
failure_reasonstring or null

For failed events, the reason the activity did not succeed.

Example:"duplicate_external_id"
created_atinteger, (date-time)

The time the activity event occurred, as a Unix timestamp in seconds.

Example:1717000000
{
  "type": "contact_activity",
  "id": "1717000000000.0000a1",
  "event_type": "contact.created",
  "contact_id": "6329bd9ffe4e2e91dc5d6a1e",
  "external_id": "user-42",
  "role": "user",
  "merge_source_id": "5f7f0d217c3f2e001a4e8b12",
  "merge_target_id": "6329bd9ffe4e2e91dc5d6a1e",
  "failure_reason": "duplicate_external_id",
  "created_at": 1717000000
}