How do I give API access to a specific campaign?
When an external partner needs to read or write leads in one specific campaign, create a campaign-scoped API token. This restricts their access to only the data slice that belongs to them.
TL;DR
1. Add source value in Selects. 2. Create campaign filter (source = partner value). 3. Create API token with that filter. 4. Share public API URL + token. Partner's documentation auto-shows the campaign schema. Always include the source value in partner-created leads so they stay inside the filter.
Get started in 4 steps
Add a source value for the partner
Open the campaign → Selects. Find the source/vendor list and add a new option for the partner (e.g. "Partner ABC", "Vendor North"). Save. This value tags their leads in the system.
Create a campaign filter for the partner
In the campaign → Filters → New filter. Name it after the partner. Add condition: source field = partner's select value. Save. This filter is the data slice the token will see.
Create a campaign-scoped API token
In the campaign → API documentation (new UI) → API Tokens → New API token. Name it (e.g. "Partner ABC – read/write"). Set permissions. Under Campaign filter, select the filter from step 2. Save.
Share API URL and token with partner
Click the link icon to copy the public API documentation URL. Click Show to reveal the token string. Send both to the partner. The documentation auto-shows all fields, statuses, selects, and schemas for this campaign specifically.
Read more⌄
Security best practices
- Each vendor should have their own dedicated API token
- Never reuse tokens across campaigns or vendors
- Rotate or revoke tokens when no longer needed
- Avoid giving write access unless required
- Keep filters strict — include only the partner's data segment
Recommended: include source when creating leads
Partners should always include the correct source value when creating leads via the API. Example payload fragment:
"select_field_values": {
"select_partner": "SELECT_PARTNER"
}
This ensures new leads fall inside the correct filter scope and the partner can read them back immediately.
Common searches
campaign api access • vendor api token • scoped api • partner api • api filter campaign
Was this article helpful?
That’s Great!
Thank you for your feedback
Sorry! We couldn't be helpful
Thank you for your feedback
Feedback sent
We appreciate your effort and will try to fix the article