Skip to main content
POST
/
v1
/
order
/
leads
Add a new lead to campaign
curl --request POST \
  --url https://affilate.adscrush.com/api/v1/order/leads \
  --header 'API_KEY: <api-key>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "campaignCode": "<string>",
  "name": "<string>",
  "phone": "<string>",
  "address": "<string>",
  "email": "[email protected]",
  "country": "<string>",
  "region": "<string>",
  "city": "<string>",
  "street": "<string>",
  "zipcode": "<string>",
  "website": "<string>",
  "description": "<string>"
}
'
{
  "success": true,
  "lead": {
    "id": "<string>",
    "name": "<string>",
    "phone": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "campaignId": "<string>",
    "userId": "<string>",
    "ip": "<string>",
    "address": "<string>",
    "state": "<string>",
    "region": "<string>",
    "country": "<string>",
    "status": "OnHold"
  }
}

Authorizations

​
API_KEY
string
header
required

Your API key. Include this key in the API_KEY header when making requests to endpoints that require authentication. You can find your API key in the 'Profile' tab on the website.

​
Authorization
string
header
required

Your Bearer Token. Include this token in the 'Authorization' header as Bearer <your_token> when making requests to endpoints that require user authentication. You can view and manage your Bearer Token in the 'Profile' tab on the website.

Body

application/json
​
campaignCode
string
required
​
name
string
required

Name is required. The name of the lead.

​
phone
string
required

The phone number of the lead.

​
address
string

The address of the lead.

​
email
string<email>

Email for the lead. this field is optional

​
country
string

Country for the lead. this field is optional

​
region
string

Region for the lead. this field is optional

​
city
string

City for the lead. this field is optional

​
street
string

Street for the lead. this field is optional

​
zipcode
string

Zipcode for the lead. this field is optional

​
website
string

Website for the lead. this field is optional

​
description
string

Description for the lead. this field is optional

Response

Successful response

​
success
boolean
Example:

true

​
lead
object

Represents a lead in the Adscrush CRM system.