Skip to main content
POST
outreach.contact.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
name
string
required

Contact name.

Required string length: 1 - 256
email
string

Email address.

Required string length: 1 - 320
Pattern: ^[^\s@]+@[^\s@]+\.[^\s@]+$
company
string

Company name.

Required string length: 1 - 256
tags
string[]

Up to 20 tags.

Maximum array length: 20
Required string length: 1 - 128
subscribed
boolean

Whether the person agreed to receive messages. Defaults to true.

notes
string

Notes about the contact.

Required string length: 1 - 2000
channel
object

A messaging channel to link to the contact.

Response

The result

contactId
string
required

Pass back to outreach.contact.update / delete, sequence enroll and broadcast recipients.

name
string
required

Contact name.

email
string

Email address.

company
string

Company name.

tags
string[]

Tags on the contact.

subscribed
boolean

False once the person opted out. Respecting it is your responsibility.

blocked
boolean

Whether the contact is blocked.

platform
string

Lowercase name of the channel the contact is on.

createdAt
string

When the contact was created, ISO 8601.