Skip to main content
CustomersVersion: v3

Create customer lead

POST/affiliate-manager/{locationId}/affiliates/{affiliateId}/lead/create

Create or update a lead for an affiliate customer.

Authorizations

Authorizationstringheaderrequired

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

Scope:affiliate-manager.write
Auth methods:OAuthPrivate Integration
Token type:Sub-Account Token

Request​

Headers

Versionstringrequired

API Version

Available optionsv3
Example:v3

Path Parameters

locationIdstringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT
affiliateIdstringrequired

Affiliate Id

Example:ve9EPM428h8vShlRW1KT

Body

firstNamestring

First Name

Example:John
lastNamestring

Last Name

Example:Deo
emailstringrequired

email

phonestring

phone

Example:+91 88888 88888
campaignIdstringrequired

Campaign Id

Example:ve9EPM428h8vShlRW1KT
contactIdstring

CRM contact identifier

Example:ve9EPM428h8vShlRW1KT

Response

Successful response

_idstringrequired

Customer identifier

Example:ve9EPM428h8vShlRW1KT
locationIdstringrequired

Location identifier

Example:ve9EPM428h8vShlRW1KT
affiliateIdstringrequired

Affiliate identifier

Example:ve9EPM428h8vShlRW1KT
campaignIdstringrequired

Campaign identifier

Example:ve9EPM428h8vShlRW1KT
contactIdstringrequired

Contact identifier

Example:ve9EPM428h8vShlRW1KT
firstNamestring

Customer first name

Example:John
lastNamestring

Customer last name

Example:Doe
emailstring

Customer email address

phonestring

Customer phone number

Example:+15551234567
typestring

Customer type

Available optionsleadcustomerdropped
Example:customer
subscriptionIdstring

Subscription identifier

Example:sub_123
dueAtstring<date-time>

Customer due date

Example:2026-01-01T00:00:00.000Z
deletedbooleanrequired

Whether the customer is deleted

Example:false
isDisabledbooleanrequired

Whether the customer is disabled

Example:true
createdAtstring<date-time>

Customer creation timestamp

Example:2026-01-01T00:00:00.000Z
updatedAtstring<date-time>

Customer update timestamp

Example:2026-01-01T00:00:00.000Z