Campaigns
No OAuth-enabled endpoints in this section. Turn off the OAuth filter in the sidebar to see all of its endpoints.
In-dashboard marketing campaign management
Create Campaign
User sessionAPI credentialcampaigns:writeRequest bodyapplication/json
buttontext[][]201Created application/json
dataCampaign
User who created the campaign.
Button kind: optional supporting text beside the button (wide places only).
OR — hide if the user matches any of these; overrides targeting.
Button kind: button target (internal path or URL).
buttontextButton kind: button caption.
Text kind: optional inline link target (internal path or URL).
Text kind: optional inline link caption.
Admin-facing label (list column).
Provider context the campaign was created under.
Target providers; empty = all providers (global admins only).
AND — user must match every attribute; empty = everyone.
Text kind: plain-text body (no HTML).
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Live Campaigns
Campaigns currently live for the authenticated user.
User sessionAPI credential200Campaigns application/json
dataCampaign[]
User who created the campaign.
Button kind: optional supporting text beside the button (wide places only).
OR — hide if the user matches any of these; overrides targeting.
Button kind: button target (internal path or URL).
buttontextButton kind: button caption.
Text kind: optional inline link target (internal path or URL).
Text kind: optional inline link caption.
Admin-facing label (list column).
Provider context the campaign was created under.
Target providers; empty = all providers (global admins only).
AND — user must match every attribute; empty = everyone.
Text kind: plain-text body (no HTML).
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Search Campaigns
User sessionAPI credentialcampaigns:readRequest bodyapplication/json
50min 10min 0200Campaigns application/json
dataCampaign[]
User who created the campaign.
Button kind: optional supporting text beside the button (wide places only).
OR — hide if the user matches any of these; overrides targeting.
Button kind: button target (internal path or URL).
buttontextButton kind: button caption.
Text kind: optional inline link target (internal path or URL).
Text kind: optional inline link caption.
Admin-facing label (list column).
Provider context the campaign was created under.
Target providers; empty = all providers (global admins only).
AND — user must match every attribute; empty = everyone.
Text kind: plain-text body (no HTML).
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Update Campaign
User sessionAPI credentialcampaigns:writePath parameters1
Request bodyapplication/json
buttontext200Updated application/json
dataCampaign
User who created the campaign.
Button kind: optional supporting text beside the button (wide places only).
OR — hide if the user matches any of these; overrides targeting.
Button kind: button target (internal path or URL).
buttontextButton kind: button caption.
Text kind: optional inline link target (internal path or URL).
Text kind: optional inline link caption.
Admin-facing label (list column).
Provider context the campaign was created under.
Target providers; empty = all providers (global admins only).
AND — user must match every attribute; empty = everyone.
Text kind: plain-text body (no HTML).
metaobject
400Invalid Request application/json
errorobject
401Unauthorized application/json
errorobject
403Forbidden: missing a required permission, or no access to this resource application/json
errorobject
404Not Found application/json
errorobject
500Internal server error application/json
errorobject
Delete Campaign
User sessionAPI credentialcampaigns:write