API documentation  PUT /leads/{id}

Update a lead

PUT https://demo.trafficmanager.com/api/v1/leads/{id}

GET https://postback.trafficman.io/lead/?lead={id}&key={key}&status={status}

GET Parameters:

• {id}: Lead ID or UUID

POST Parameters:

• key: your advertiser key. It can be found here.
• status: new lead status to apply. It must be one of the following:
  

  STATUS_TRASH
  STATUS_DOUBLE
  STATUS_POTENTIAL_DOUBLE
  STATUS_PENDING
  STATUS_CONFIRMED
  STATUS_CANCELED
  STATUS_CALL_BACK
  STATUS_SHIPPED
  STATUS_DELIVERED
  STATUS_RETURNED
  STATUS_UNREACHABLE
  

  To make it easier to integrate with all the networks, we support also these common aliases (case-insensitive):

  'pending', 'new' => 'STATUS_PENDING',
  'denied', 'declined', 'wrong', 'expired', 'not interested', 'wrong number', 'canceled', 'cancelled', 'reject', 'rejected', 'fail' => 'STATUS_CANCELED',
  'confirmed', 'approved', 'confirm' => 'STATUS_CONFIRMED',
  'hold', 'call_later', 'call_later_scheduled', 'no_reply', 'no answer', 'call again', 'expect' => 'STATUS_CALL_BACK',
  'double', 'duplicated' => 'STATUS_DOUBLE',
  'fake', 'trash' => 'STATUS_TRASH',
  'shipped' => 'STATUS_SHIPPED',
  'delivered' => 'STATUS_DELIVERED',
  'return', 'returned' => 'STATUS_RETURNED',
  'unreachable' => 'STATUS_UNREACHABLE',
  

• notes (optional): call center notes. If you do not want to update the notes, do not send this parameter. Sending an empty value will clear the existing notes.

• name: Full name
• given-name: First name / Given name
• family-name: Last name / Surname / Family name or equivalent
• tel: Full telephone number, with or without country code
• street-address: Full address. Multiple lines of text are allowed. It may include the city, if the user is shown only a single input.
• address-level2: The second administrative level, usually the city/town/village. See MDN for more information.
• address-level1: The first administrative level in the address: State, country, province or similar.
• email: User email address
• postal-code: A postal code (ZIP code in the United States)
• Product variations Some products can have multiple variations (for example, size, color, quantity...). In that case, it's required to send the variation code and name as you see in the offer page.
  Different variations can have different price for the end user and payout for the affiliate.

Response codes:

• 200: Operation completed successfully.
• 400: Invalid request. One or more required fields are missing or not valid.
• 403: Invalid key for the given lead.
• 404: Lead not found.

Returned values:

• status: see Response codes above
• message: one of the following:
  • Nothing to change: neither the status nor the notes are changed. No operation has been performed.
  • OK: the leads status and/or notes have been updated.
  • OK - canceled: the lead status and/or notes have been updated. Additionally, the corresponding conversion has been queued to be canceled.
  • OK - approved: the lead status and/or notes have been updated. Additionally, the corresponding conversion has been queued to be approved.
  • OK - restored pending: the lead status and/or notes have been updated. Additionally, the corresponding conversion has been queued to be restored to pending.

Response example

{
    "status": 200,
    "message": "OK - canceled"
}

{
    "status": 200,
    "message": "Nothing to change"
}

{
    "status": 403,
    "message": "Invalid key"
}