How to Find Your Offer API Tokens

Where Tokens Live

Every Offer exposes two API tokens:

• The Call Transfer Token identifies the Offer when submitting leads. A lead submitted with this token is attached to the Offer but does NOT start any schedule.
• The Dynamic Number Insertion Token identifies the Offer when requesting tracking numbers from a Ring Pool.

Every Schedule under the Offer has its own separate
lead token. A lead submitted with a schedule token
DOES start that schedule's actions.

Finding the Tokens in the UI

1. Navigate to /offers and open the Offer.
2. Click the Posting Docs & API Tokens tab on the Offer detail page.

The token view is organized into three tables:

• Offer Tokens: the Offer's lead token (Call Transfer Token) and numbers token (Dynamic Number Insertion Token). Both are marked "Does Not Start Schedule".
• Schedule Tokens: each Schedule's lead token, labeled "Add Lead To Schedule" and marked "Starts Schedule".
• Inbound PING Tokens: each inbound webhook's vanity URI, used for ping URLs such as https://<subdomain>/api/v1/inbound_webhooks/ping/:vanity_uri.

The Posting Docs & API Tokens tab is only shown to
superusers.

Choosing the Right Token

When deciding which token a third party should POST to, ask
whether the submission should start a schedule:

• If yes, give them a Schedule lead token. The lead will be enrolled and the schedule's actions will begin.
• If no, give them the Offer lead token (Call Transfer Token). The lead is attached to the offer and matched to any subsequent inbound call from the same caller, but nothing dials outbound automatically.