Create customer lead

POST 
/affiliate-manager/:locationId/affiliates/:affiliateId/lead/create

Create or update a lead for an affiliate customer.

Request

Version stringrequired

API Version

Available options2021-04-15

locationId stringrequired

Location Id

affiliateId stringrequired

Affiliate Id

application/json

application/json

Body

Bodyrequired

firstNamestring

First Name

lastNamestring

Last Name

emailstringrequired

email

phonestring

phone

campaignIdstringrequired

Campaign Id

contactIdstring

CRM contact identifier

Example (auto)

{
  "firstName": "John",
  "lastName": "Deo",
  "email": "[email protected]",
  "phone": "+91 88888 88888",
  "campaignId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT"
}

application/json

Successful response

application/json

Schema

Schema

_idstringrequired

Customer identifier

locationIdstringrequired

Location identifier

affiliateIdstringrequired

Affiliate identifier

campaignIdstringrequired

Campaign identifier

contactIdstringrequired

Contact identifier

firstNamestring

Customer first name

lastNamestring

Customer last name

emailstring

Customer email address

phonestring

Customer phone number

typestring
Customer type
Available optionsleadcustomerdropped
subscriptionIdstring

Subscription identifier

dueAtstring<date-time>

Customer due date

deletedbooleanrequired

Whether the customer is deleted

isDisabledbooleanrequired

Whether the customer is disabled

createdAtstring<date-time>

Customer creation timestamp

updatedAtstring<date-time>

Customer update timestamp

Example (auto)

{
  "_id": "ve9EPM428h8vShlRW1KT",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "affiliateId": "ve9EPM428h8vShlRW1KT",
  "campaignId": "ve9EPM428h8vShlRW1KT",
  "contactId": "ve9EPM428h8vShlRW1KT",
  "firstName": "John",
  "lastName": "Doe",
  "email": "[email protected]",
  "phone": "+15551234567",
  "type": "customer",
  "subscriptionId": "sub_123",
  "dueAt": "2026-01-01T00:00:00.000Z",
  "deleted": false,
  "isDisabled": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}