Skip to main content
POST
/
leads
/
create
cURL
curl --request POST \
  --url https://api.attent.app/v1/leads/create \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+15555555555",
  "customerProfile": "My Customer Profile",
  "timeZone": "America/New_York",
  "email": "[email protected]",
  "outboundPhone": "+15551234567",
  "additionalInfo": {
    "key1": "value1",
    "key2": "value2"
  }
}
'
{
  "message": "Lead created successfully."
}

Authorizations

​
x-api-key
string
header
required

Body

application/json

Lead to create. Phone number must be unique.

​
firstName
string
required

The first name of the lead.

​
lastName
string
required

The last name of the lead.

​
phone
string
required

The phone number must begin with an area code (+) and can contain digits, spaces, parentheses, and hyphens (e.g. +1 (555) 555-5555)

​
customerProfile
string
required

The name of the customer profile to which this lead should belong to.

​
timeZone
string

The timezone of the lead in tz database format (e.g. America/New_York, Europe/London).

​
email
string

The email address of the lead. Must be a valid email format (e.g. [email protected]).

​
outboundPhone
string

The phone number to use for outbound texts and calls to this lead. Must be a phone number configured for your organization. If not specified, the organization default phone number will be used.

​
additionalInfo
object

An optional key-value object containing additional information to store with the lead.

Response

A lead has been successfully created.

​
message
string

Returns "Lead created successfully." if the lead was created successfully.

​
id
string

The ID of the lead that was created.