Skip to main content
POST
/
v0
/
persons
Create person
curl --request POST \
  --url https://api.tryarchitect.com/v0/persons \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "domain": "<string>",
  "phoneNumber": "<string>",
  "linkedinProfileUrl": "<string>"
}
'
{
  "personId": "<string>",
  "name": "<string>",
  "email": "<string>",
  "domain": "<string>",
  "slug": "<string>",
  "phoneNumber": "<string>",
  "linkedinProfileUrl": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key authentication for the External Actor Gateway

Body

application/json
​
name
string
required
Required string length: 1 - 255
​
email
string
​
domain
string
Minimum string length: 1
​
phoneNumber
string
Pattern: ^\+[1-9]\d{1,14}$
​
linkedinProfileUrl
string
Minimum string length: 1

Response

Person created successfully

​
personId
string
required
Minimum string length: 1
​
name
string
required
​
email
string | null
required
​
domain
string | null
required
Minimum string length: 1
​
slug
string
required
​
phoneNumber
string | null
required
Pattern: ^\+[1-9]\d{1,14}$
​
linkedinProfileUrl
string | null
required
Minimum string length: 1
​
createdAt
string
required
Pattern: ^\+[1-9]\d{1,14}$
​
updatedAt
string
required
Pattern: ^\+[1-9]\d{1,14}$