Create prospect log entry

Create a prospect log entry using the authenticated API key’s tenant context

POST /v0/prospect_logs

Create prospect log entry

cURL

curl --request POST \
  --url https://api.tryarchitect.com/v0/prospect_logs \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "source": "<string>",
  "type": "webhook",
  "payload": {},
  "prospectId": "<string>",
  "email": "<string>",
  "idempotencyKey": "<string>",
  "name": "<string>"
}
'

201

{
  "prospectId": "<string>",
  "prospectLogId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdProspect": 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

Identifier for the upstream system sending the prospect activity

Required string length: 1 - 100

type · string · default: webhook · required

Prospect activity type. Defaults to 'webhook' when omitted

Required string length: 1 - 100

payload · object · required

Show child attributes

prospectId · string

Minimum string length: 1

Pattern: ^prospect_[a-z0-9]{26}$

email · string

idempotencyKey · string

Required string length: 1 - 255

name · string

Required string length: 1 - 255

Response

201 - application/json

ProspectLog created successfully

prospectId · string · required

Minimum string length: 1

Pattern: ^prospect_[a-z0-9]{26}$

prospectLogId · string · required

The created prospect log entry ID

Minimum string length: 1

Pattern: ^prospectlog_[a-z0-9]{26}$

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))$

createdProspect · boolean · required

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

source · string · required

The stored prospect log source

Required string length: 1 - 100

type · string · required

The stored prospect log type

Required string length: 1 - 100