Update person

Update a person by ID.

PATCH /v0/persons/{person_id}

Update person

cURL

curl --request PATCH \
  --url https://api.tryarchitect.com/v0/persons/{person_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "<string>",
  "email": "<string>",
  "domain": "<string>",
  "phoneNumber": "<string>",
  "linkedinProfileUrl": "<string>"
}
'

200

{
  "personId": "<string>",
  "tenantId": "<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

Path Parameters

person_id · string · required

person_id parameter

Body

application/json

name · string

Required string length: 1 - 255

email · string | null

domain · string | null

Minimum string length: 1

phoneNumber · string | null

Minimum string length: 1

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

linkedinProfileUrl · string | null

Minimum string length: 1

Response

200 - application/json

Person created successfully

personId · string · required

Minimum string length: 1

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

tenantId · string · required

name · string · required

email · string | null · required

domain · string | null · required

Minimum string length: 1

slug · string · required

phoneNumber · string | null · required

Minimum string length: 1

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

linkedinProfileUrl · string | null · required

Minimum string length: 1

createdAt · string · required

Minimum string length: 1

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

updatedAt · string · required

Minimum string length: 1

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