Skip to main content
GET
Create lead by goal ID (GET)

Authorizations

X-API-Key
string
header
required

Preferred authentication method. Pass the API key in the X-API-Key HTTP request header. The user account must have api_status enabled.

Query Parameters

goal_id
integer
required

Goal ID.

affiliate_id
integer
required

Affiliate ID.

email
string

Lead email address.

firstname
string

Lead first name.

lastname
string

Lead last name.

phone
string

Lead phone number.

deliver_lead
enum<string>

Forwards the created lead to the external systems configured for its goal. With yes the lead is posted out; with no (the default) it is only recorded in Scaleo. Delivery needs the Leads Management Module, an active Receive campaign bound to the lead's goal_id, and at least one active Deliver vendor on that campaign - without them, or when a vendor's posting instructions are empty, yes has no effect. Each vendor is called with its own posting instructions (URL, method, headers, tokenized body); its answer is matched against the vendor's success reply and sets the lead's delivery status - success, fail, or empty when the vendor has no success reply configured. Every attempt is stored in the leads log as an Outgoing Lead record. Leads that end up in the trash conversion status (failed campaign validation, geo check, or cap) are never delivered. If the vendor has "return reply" enabled, its raw response is added to the response payload as delivery_reply.

Available options:
yes,
no

Response

Lead creation result.

status
string
Example:

"success"

code
integer
Example:

200

name
string
Example:

"OK"

message
string
info
object