POST
/
api
/
event
/
{campaign-id}
cURL
curl --request POST \
  --url https://api.pingtree.com/api/event/{campaign-id} \
  --header 'Content-Type: application/json' \
  --data '{
  "transaction_id": "<string>",
  "event_id": "<string>",
  "clid": "<string>",
  "amount": 123,
  "pid": "<string>",
  "conversion_date": "<string>",
  "conversion_timezone": "<string>",
  "sub1": "<string>",
  "sub2": "<string>",
  "sub3": "<string>",
  "sub4": "<string>",
  "sub5": "<string>",
  "adv1": "<string>",
  "adv2": "<string>",
  "adv3": "<string>",
  "adv4": "<string>",
  "adv5": "<string>",
  "utm_source": "<string>",
  "utm_medium": "<string>",
  "utm_campaign": "<string>",
  "utm_adgroup": "<string>",
  "utm_matchtype": "<string>",
  "utm_term": "<string>",
  "utm_content": "<string>",
  "external_clickid": "<string>",
  "utm_creative": "<string>",
  "utm_placement": "<string>",
  "tcpa_consent_date": "<string>",
  "tcpa_consent": 123,
  "cost": 123,
  "cost_operation": "<string>",
  "adSpend": 123,
  "min_price": 123
}'
{
  "status": "<string>",
  "type": "<string>",
  "message": "<string>",
  "missingFields": {},
  "invalidFields": {}
}

Path Parameters

​
campaign-id
string
required

Your campaign ID

Body

application/json

Lead details to add to the campaign

​
transaction_id
string
required

Lead's Transaction ID, Which was generate from click script of Pingtree

​
event_id
string
required

Event ID which you want to fire for the lead

​
clid
string

clid of the offer

​
amount
number

Amount is conversion amount for lead

​
pid
string

PID is partner ID

​
conversion_date
string

conversion_date should be as following, 'YYYY-MM-DD' or 'YYYY-MM-DD HH:MM:SS'

​
conversion_timezone
string

conversion_timezone should be as following, 'PST'(For Pacific Stand Time (UTC-8)), 'EST'(For Eastern Standard Time (UTC-5)), 'CST'(For Central Standard Time (UTC-6)), 'MST'(For Mountain Standard Time (UTC-7)), 'AKST'(For laska Standard Time (UTC-9)), 'SST'(For Samoa Standard Time (UTC-11)), 'HST'(For Hawaii-Aleutian Time (UTC-10)), 'AST'(For Atlantic Standard Time (UTC−4)

​
sub1
string

Sub ID 1 of lead's partner tracking URL

​
sub2
string

Sub ID 2 of lead's partner tracking URL

​
sub3
string

Sub ID 3 of lead's partner tracking URL

​
sub4
string

Sub ID 4 of lead's partner tracking URL

​
sub5
string

Sub ID 5 of lead's partner tracking URL

​
adv1
string

Adv ID 1 of lead's partner tracking URL

​
adv2
string

Adv ID 2 of lead's partner tracking URL

​
adv3
string

Adv ID 3 of lead's partner tracking URL

​
adv4
string

Adv ID 4 of lead's partner tracking URL

​
adv5
string

Adv ID 5 of lead's partner tracking URL

​
utm_source
string

UTM Source of lead's partner tracking URL

​
utm_medium
string

UTM Medium of lead's partner tracking URL

​
utm_campaign
string

UTM Campaign of lead's partner tracking URL

​
utm_adgroup
string

UTM AdGroup of lead's partner tracking URL

​
utm_matchtype
string

UTM MatchType of lead's partner tracking URL

​
utm_term
string

UTM Term of lead's partner tracking URL

​
utm_content
string

UTM Content of lead's partner tracking URL

​
external_clickid
string

External Click ID of lead's partner tracking URL

​
utm_creative
string

UTM Creative of lead's partner tracking URL

​
utm_placement
string

UTM Placement of lead's partner tracking URL

​
tcpa_consent_date
string

TCPA Consent Date in YYYY-MM-DD format

​
tcpa_consent
number

TCPA consent field as 0 or 1

​
cost
number

Cost of the lead

​
cost_operation
string

Cose Operation for of the lead's cost. Possible values are 'add', 'substract', and 'override'.

​
adSpend
number

Adspend of the lead

​
min_price
number

Send minimum buying price to buyer, if buyer is ready to buy lead at min price or greater, then only we will sell lead

​
{key}

You can send any other lead details like first_name, last_name, address, etc. You can find all lead fields in the 'Field Management' Page inside your Pingree account.

Response

Event successfully fired

​
status
string

Status code of API response

​
type
string

Type of API response which can be success or error

​
message
string

Message of API response

​
missingFields
object

Missing lead's fields

​
invalidFields
object

Missing lead's fields