Skip to main content

Authentication

This action does not require an API key. Instead, the target channel must have its public API enabled (no_auth_api set to true). You can check this via get_channels.
Because this action is unauthenticated, treat the channel ID as a secret if you do not want unauthorized submissions.

Request

string
required
Must be "lead_external".
uuid
required
The channel to create the lead in. Accepts either the channel’s primary ID or its public uuid. The channel must have its public API enabled.
string
Contact email address.
string
First name of the contact.
string
Last name of the contact.
string
Phone number.
string
Company name of the lead.
string
How the lead was sourced.
string
Employee associated with the lead.
string
Free-text notes about the lead.
string
An external identifier from your own system.
array
Custom property values to set on the lead. Each item requires a property_definitions_id and a value.

Response

Returns the created lead object. The lead is automatically assigned the first lead status defined on the channel.

Side effects

  • Reward triggers: If the channel has active reward triggers for new_lead, reward events are created automatically.
Unlike the authenticated create_lead action, lead_external does not trigger webhooks or in-app notifications.

Example

Request

Response

Errors