Skip to main content
POST
Upsert a source identity

Authorizations

Authorization
string
header
required

Project-scoped secret API key (sk_…). Pass in the Authorization: Bearer <key> header. Grants access to the project the key was issued for.

Body

application/json
source
string
required
Required string length: 1 - 64
Pattern: ^[a-z][a-z0-9_]*$
source_person_id
string
required
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$
external_id
string
required
Pattern: ^[a-f0-9]{64}$
email
string<email>
required
Maximum string length: 255
anonymous_id
string
Maximum string length: 255
phone
string
Maximum string length: 255
timezone
string
Maximum string length: 255
locale
string
Maximum string length: 32
data
object

Response

The source identity upsert result.

status
enum<string>
required
Available options:
upserted,
quarantined
reason
enum<string>
Available options:
email_hash_conflict
contact
object