Skip to main content
POST
/
api
/
outreach
Trigger outreach processing for a lead
curl --request POST \
  --url https://your-instance.example.com/api/outreach \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "Jamie",
  "lastName": "Lee",
  "phoneNumber": "+14155550133",
  "email": "jamie.lee@example.com",
  "source": "Facebook Lead Ad"
}
'
{
  "success": true,
  "message": "Data processed successfully",
  "data": {
    "contactId": "64b2c3d4e5f60012345678aa",
    "applicationId": "64d2f9c5e8a1d4e001a0b1c2",
    "conversationId": "64d2f9c5e8a1d4e001a0b1c3",
    "mergeOutcome": "created"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Lead data payload. Accepts arbitrary additional fields that are mapped to contact dynamic properties.

​
phoneNumber
string

Lead phone number; normalized to E.164 server-side. Required unless contactId/_id/id is supplied.

​
email
string

Lead email; normalized to lowercase.

​
firstName
string

Lead first name used when creating a new contact.

​
lastName
string

Lead last name used when creating a new contact.

​
name
string

Single-field display name fallback when firstName/lastName are not supplied.

​
contactId
string

Contact _id for an existing contact; bypasses the create-or-merge lookup.

​
_id
string

Contact _id for an existing contact; bypasses the create-or-merge lookup.

​
id
string

Contact _id for an existing contact; bypasses the create-or-merge lookup.

Response

Outreach processed successfully

Returned by POST /api/outreach. data carries resolved IDs the caller may need to follow up.

​
success
enum<boolean>
required
Available options:
true
​
message
string
required
​
data
object