Skip to main content
POST
/
api
/
v1
/
accounts
/
{account_id}
/
leads
Create a lead
curl --request POST \
  --url https://connect.voxys.ai/api/v1/accounts/{account_id}/leads \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "custom_name": "Enterprise Deal - Q3",
  "lead_value": 15000,
  "lead_currency": "USD",
  "assigned_agent_id": 1,
  "position": 1,
  "conversation_id": 100,
  "company_id": 10,
  "custom_attributes": {
    "industry": "Technology",
    "annual_revenue": 500000
  }
}
'
{
  "id": 42,
  "custom_name": "Enterprise Deal - Q3",
  "status": "open",
  "lead_value": 15000,
  "lead_currency": "USD",
  "position": 1,
  "notes": "Prospect from trade show",
  "assigned_agent": {
    "id": 1,
    "name": "Jane Smith",
    "email": "jane@example.com",
    "avatar_url": "<string>"
  },
  "company": {
    "id": 10,
    "name": "Acme Corp",
    "domain": "acme.com"
  },
  "conversation_id": 100,
  "custom_attributes": {
    "industry": "Technology",
    "annual_revenue": 500000
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://developers.voxys.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
api_access_token
string
header
required

API access token for authentication. Obtain from your Voxys Connect profile settings.

Path Parameters

​
account_id
integer
required

The numeric ID of the account.

Body

application/json
​
custom_name
string
Example:

"Enterprise Deal - Q3"

​
lead_value
number<float> | null
Example:

15000

​
lead_currency
string | null
Example:

"USD"

​
assigned_agent_id
integer | null
Example:

1

​
position
integer | null
Example:

1

​
conversation_id
integer | null
Example:

100

​
company_id
integer | null
Example:

10

​
custom_attributes
object

Flexible key-value map of custom attributes defined for the account.

Example:
{
  "industry": "Technology",
  "annual_revenue": 500000
}

Response

Lead created successfully.

​
id
integer
Example:

42

​
custom_name
string
Example:

"Enterprise Deal - Q3"

​
status
enum<string>
Available options:
open,
won,
lost,
snoozed
Example:

"open"

​
lead_value
number<float> | null
Example:

15000

​
lead_currency
string | null
Example:

"USD"

​
position
integer | null
Example:

1

​
notes
string | null
Example:

"Prospect from trade show"

​
assigned_agent
object
​
company
object
​
conversation_id
integer | null
Example:

100

​
custom_attributes
object

Flexible key-value map of custom attributes defined for the account.

Example:
{
  "industry": "Technology",
  "annual_revenue": 500000
}
​
created_at
string<date-time>
​
updated_at
string<date-time>