Skip to main content
New to Corsair? See API access, authentication, and error handling.

Attachments

create

attachments.create Create a contest or a social unlock Risk: write
Input Output

delete

attachments.delete Delete a contest or unlock; there is no restore route Risk: destructive · Irreversible
Input Output: object

entries

attachments.entries Read a contest entry time series, by platform Risk: read
Input Output

entriesTotals

attachments.entriesTotals Read entry counts over the past day, week, month and lifetime Risk: read
Input Output

get

attachments.get Read one contest or unlock with its actions Risk: read
Input Output

listForUser

attachments.listForUser List one user’s contests and social unlocks Risk: read
Input Output

unlockPlatforms

attachments.unlockPlatforms Read unlock counts by platform Risk: read
Input Output

unlocks

attachments.unlocks Read a social unlock time series Risk: read
Input Output

unlocksTotals

attachments.unlocksTotals Read unlock counts over the past day, week, month and lifetime Risk: read
Input Output

update

attachments.update Change the fields of one contest or unlock Risk: write
Input Output

Campaigns

create

campaigns.create Create an ad campaign on Facebook or Google; creating one can start spend, so review the body before calling Risk: destructive
Input Creates a real campaign on Facebook or Google. ToneDen documents no required field, so pass the targeting and creative fields the campaign type needs. Output

creativeInsights

campaigns.creativeInsights Read performance data for each ad within a campaign Risk: read
Input Returns performance for each ad within the campaign rather than one total. Output

delete

campaigns.delete Delete an ad campaign; there is no restore route Risk: destructive · Irreversible
Input Output: object

get

campaigns.get Read one ad campaign Risk: read
Input Output

insights

campaigns.insights Read one campaign performance data Risk: read
Input Output

list

campaigns.list List one user’s ad campaigns Risk: read
Input Output

update

campaigns.update Change an ad campaign; only the given fields are sent Risk: destructive
Input Only the fields you pass are sent. Use status to pause or resume. Output

create

links.create Create a link with its target, artwork, services and social settings Risk: write
Input
Output

delete

links.delete Delete a link; there is no restore route Risk: destructive · Irreversible
Input A deleted link cannot be restored. Output: object

expand

links.expand Expand a music or podcast URL into the tracking pixels, affiliate codes and services a link would carry Risk: read
Input Output

get

links.get Read one link with its services, pixels and social settings Risk: read
Input Output

insights

links.insights Read one link’s performance over a date window Risk: read
Input Output

insightsOverview

links.insightsOverview Read a summary of one link’s performance Risk: read
Input Output

listForUser

links.listForUser List one user’s links Risk: read
Input Output

update

links.update Change the fields of one link; only the given fields are sent Risk: write
Input Only the fields you pass are sent, and a call with no field is rejected before the request.
Output

validPath

links.validPath Check whether a path and subdomain are still available; answers 200 with valid: false rather than failing Risk: read
Input A taken path answers 200 with valid: false and a reason; it is not an error. Output

Offline Conversions

upload

offlineConversions.upload Upload offline conversions for a user Risk: write
Input
Output: object

Playbooks

create

playbooks.create Create a playbook campaign from a template Risk: destructive
Input Output

delete

playbooks.delete Delete a playbook campaign; there is no restore route Risk: destructive · Irreversible
Input Output: object

get

playbooks.get Read one playbook campaign Risk: read
Input Output

update

playbooks.update Change a playbook campaign title or archive state Risk: destructive
Input Only the fields you pass are sent; archive rather than delete to keep the history. Output

User Lists

create

userLists.create Create a user list for a Facebook custom audience; the feature requires access from ToneDen support Risk: write
Input ToneDen asks you to contact support for access to user lists before using this. Output

list

userLists.list List one user’s advertising user lists Risk: read
Input Output

updateContacts

userLists.updateContacts Add or remove people in a user list Risk: write
Input
Output: object

Users

get

users.get Read a user profile Risk: read
Input Output

update

users.update Change a user profile’s name, email or location Risk: write
Input Output