Provide Lead

šŸ”’

Required scope: platform:write

The API credential calling this endpoint must be granted the platform category with read & write access.
Scopes are assigned to the credential when it is created or edited in Pliant, not requested when obtaining the access token.
A credential without this scope receives 403 Forbidden with the error code INSUFFICIENT_PERMISSION.

Provide a new customer lead to Pliant for a customer referred by you, the partner. This lead will be picked up by our Sales team and they will onboard the customer as a new organization to Pliant. The details depend on the specific agreement Pliant has with you, the partner. More details can be found in our guides section.

Body Params
company
object
required

The legal entity that is referred to Pliant.

contacts
array of objects | null
contacts
string

Any other important aspects to consider?

string
deprecated

Unique identifier for customer/organization in your system. Used in various endpoints/callbacks to help you mapping Pliant organizationId accordingly.

string

Unique identifier for customer/organization in your system. Used in various endpoints/callbacks to help you mapping Pliant organizationId accordingly.

partnerContact
object

Contact person at the partner organization responsible for this lead.

Responses
200

Ok

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Choose an example:
application/json