auth
- GETDecode access token
- POSTAuthenticate to get access tokens
- POSTAuthenticate to get access tokens
- POSTInitiate Forgot Password for the specified user
- POSTInitiate Forgot Password for the specified user
- POSTConfirm signup using confirmation code
- POSTUpdate a new user according to the partner id
- POSTCreate a new user according to the partner id
- POSTRefresh access tokens
- GETThis endpoint is only for testing purposes, will throw an exception
- GETAllow the fd-admin to get all users
- GETAllow the fd-admin to get all users
campaign_results
campaigns
- POSTPost campaigns
- GETGet campaignsby partner id
- GETReturns count of facebook adsets for the current signed in partner
- GETReturns meta tags for a page url
- PUTReturns list of campaigns
- GETReturns Campaign statistics
- GETReturns list of campaigns
- GETGet campaigns
- PUTUpdate creative content for campaign
- PUTPut campaigns ignore
- PUTUpdate target audience content for campaign
campaigns_setup
daily_revenue_summary
events
- GETReturns list of events (by default starting from today)
- GETReturns list of upcoming flagged events
- GETGet eventsget venues
- GETGet eventshas active campaigns
- PUTPut eventssetup campaign optimisation status
- GETGet eventssetup client campaign status
- PUTPut eventssetup client campaign status
- GETFaked for simulation testing
- POSTFaked for simulation testing
- GETReturns overall statistics
- PUTPut eventsunarchive
- GETGet eventsvenues
- GETGet events clusters
- GETGet events
- GETGet events benchmark
- GETGet events budget min max
- GETGet events budget range
- GETReturns list of campaigns
- GETGet events campaigns expected value
- GETReturn the default values for (total_budget,goal,tcs)
- PUTPut events init campaigns setup
- PUTPut events reset campaigns setup
- GETGet events sales graph
- GETReturns list of events in the series of the given event
- PUTPut events setup frontend status
- GETReturns event specific statistics
- GETGet events suggested tcs
- GETGet events tickets
fb_targeting
ingest
- POSTReturns number of campaigns imported into the database
- POSTReturns number of campaigns imported into the database
- POSTReturns number of events imported into the database
- POSTReturns number of events imported into the database
- POSTReturns number of sales imported into the database
- POSTReturns number of sales imported into the database
- POSTAdd a transaction summary log to S3, return created invoice id
- POSTAdd a transaction summary log to S3 from an Excel file,
messages
- GETReturns a list of partner messages (newest first and only 10 per page)
- GETAllow the fd-admin user to get a list of partner messages (newest first and only 10 per page)
- POSTAllow the fd-admin user to post messages to specific partner
- GETGet total number of unread messages for the current partner-id
- PUTMark the message with the provided message_id as read
notifications
- GETPage notifications for current user
- POSTCreate a new notification
- PATCHMark all or selected notifications as read/unread
- GETGet authenticated user's notification settings
- PUTUpdate notification setting for authenticated user
- PATCHToggle all notification settings for authenticated user
- GETGet notification stats for current user
- GETGet notification topics
- GETGet notification by ID
- PUTUpdate notification by ID
package_builder
- GETget packages by client
- POSTpost a new run package
- POSTget package info by id
- POSTpost a package content
- PUTPut package builderpackagesruns status
- GETget package info by id
- GETget package info by id
- PATCHGiven a package_id, update the status, the content and
- POSTGiven a package_id, trigger the PackageBuilderFlow to fill necessary fields
partner_integrations
partners
profile
prompts
rest_demo_data
setup_processes
storage
Error
A valid request URL is required to generate request examples{
"total": 123,
"limit": 123,
"page": 123,
"pages": 123,
"nextPage": "<string>",
"prevPage": "<string>",
"items": [
{
"notification_topic": "EVENT",
"id": 123,
"title": "<string>",
"body": "<string>",
"action_url": "<string>",
"is_read": true,
"sent_at": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z"
}
]
}notifications
Create a new notification
POST
/
notifications
Error
A valid request URL is required to generate request examples{
"total": 123,
"limit": 123,
"page": 123,
"pages": 123,
"nextPage": "<string>",
"prevPage": "<string>",
"items": [
{
"notification_topic": "EVENT",
"id": 123,
"title": "<string>",
"body": "<string>",
"action_url": "<string>",
"is_read": true,
"sent_at": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Copy your Cognito JWT Token below: 'Bearer <JWT>'
Body
application/json
User's email to send the notification to.
Notification action url
The notification topic
Available options:
EVENT, CAMPAIGN, GENERAL, ALERT, INTEGRATION Example:
"EVENT"
Notification title or subject if template_name was not specified and send_email was true
Notification body
SES email template name
SES email template data
Response
Success
Total number of results
Number of items per page of results
Number of this page of results
Total number of pages of results
Relative uri of next page or null if not valid
Relative uri of prev page or null if not valid
Show child attributes
Show child attributes
⌘I