Skip to main content
POST
Create person log entry

Authorizations

x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
source
string
required

Stored person log source

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
type
string
default:webhook
required

Kebab-case person activity type. Defaults to 'webhook' when omitted (e.g. 'contact-update')

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
payload
object
required
personId
string

Existing person ID to attach the log entry to

Minimum string length: 1
email
string
phoneNumber
string<date-time>
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
linkedinProfileUrl
string
Minimum string length: 1
idempotencyKey
string
Required string length: 1 - 255
name
string
Required string length: 1 - 255

Response

PersonLog created successfully

personId
string
required

The person that received the log entry

Minimum string length: 1
personLogId
string
required

The created person log entry ID

Minimum string length: 1
createdAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
createdPerson
boolean
required

Whether the request auto-created a person before writing the log

source
string
required

Stored person log source

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$
type
string
required

Stored person log source

Required string length: 1 - 100
Pattern: ^[a-z0-9]+(-[a-z0-9]+)*$