Skip to main content
POST
/
v0
/
person_logs
Create person log entry
curl --request POST \
  --url https://api.tryarchitect.com/v0/person_logs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source": "<string>",
  "type": "webhook",
  "payload": {},
  "personId": "<string>",
  "email": "<string>",
  "phoneNumber": "<string>",
  "linkedinProfileUrl": "<string>",
  "idempotencyKey": "<string>",
  "name": "<string>"
}
'
{
  "personId": "<string>",
  "personLogId": "<string>",
  "createdAt": "<string>",
  "createdPerson": true,
  "source": "<string>",
  "type": "<string>"
}

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
Pattern: ^\+[1-9]\d{1,14}$
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
required
Pattern: ^\+[1-9]\d{1,14}$
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]+)*$