Campaign

get
Campaign list
https://partner-api.sddan.com/api/v1/public/event-notify/campaign
Get campaign list
Request
Response
Request
Headers
Authorization
required
string
token
Query Parameters
size
optional
number
number of maximum campaign returned by call
page
optional
number
​
Response
200: OK
[
    {
      "id": "xxxxxxx-2feb-481a-9910-6d71dc337b00",
      "id_audience": "xxxxxx-6e58-4db7-8ada-53b7bace6da4",
      "id_partner": 12345,
      "name": "My first campaign",
      "notify_method": "WEBHOOK",
      "devices": [
        "DESKTOP",
        "MOBILE"
      ],
      "event": [
        "ONLINE"
      ],
      "map_value_types": [
        "EMAIL_HASH"
      ],
      "active": true,
      "start": "2019-07-25T17:09:41.32419522+02:00",
      "end": "2019-09-30T00:09:41.32419522+02:00",
      "max_event_age_in_second": 300,
      "max_notifying_per_id": 1000,
      "delay_before_notify_same_id_in_second": 3600,
      "webhook_endpoint": "https://my-endpoint.com/api/v1/endpoint",
      "capping_notify_per_minute": null,
      "status_endpoint": null,
      "filter_partner_audience": true,
      "ready_for_activation": true,
      "uploaded_ids": 0
    }
]
404: Not Found
Could not find a cake matching this query.
​
get
Campaign
https://partner-api.sddan.com/api/v1/public/event-notify/campaign/:id
Request
Response
Request
Path Parameters
id
required
string
campaign id
Headers
Authorization
required
string
token
Response
200: OK
    {
      "id": "xxxxxxx-2feb-481a-9910-6d71dc337b00",
      "id_audience": "xxxxxx-6e58-4db7-8ada-53b7bace6da4",
      "id_partner": 12345,
      "name": "My first campaign",
      "notify_method": "WEBHOOK",
      "devices": [
        "DESKTOP",
        "MOBILE"
      ],
      "event": [
        "ONLINE"
      ],
      "map_value_types": [
        "EMAIL_HASH"
      ],
      "active": true,
      "start": "2019-07-25T17:09:41.32419522+02:00",
      "end": "2019-09-30T00:09:41.32419522+02:00",
      "max_event_age_in_second": 300,
      "max_notifying_per_id": 1000,
      "delay_before_notify_same_id_in_second": 3600,
      "webhook_endpoint": "https://my-endpoint.com/api/v1/endpoint",
      "capping_notify_per_minute": null,
      "status_endpoint": null,
      "filter_partner_audience": true,
      "ready_for_activation": true,
      "uploaded_ids": 0
    }
404: Not Found
​
post
Create campaign
https://partner-api.sddan.com/api/v1/public/event-notify/campaign
JSON body
Request
Response
Request
Headers
Authorization
required
string
token
Body Parameters
filter_partner_audience
optional
boolean
should used only traffic linked to partner id?
ready_for_activation
optional
boolean
is campaign should start?
status_endpoint
optional
string
if precise, notify service will call this URL to check if notifying must continue
capping_notify_per_minute
optional
number
max number of notify sent by minute
webhook_endpoint
required
string
url called by service to notify
delay_before_notify_same_id_in_second
required
number
​
max_notifying_per_id
required
number
max notification by hash (or reference id if used in upload)
max_event_age_in_second
required
number
max event age in second before notification
end
required
string
end time, example : 
2019-10-01T00:09:41.32419522+02:00
start
required
string
start time, example : 
2019-07-25T17:09:41.32419522+02:00
map_value_types
required
string
["EMAIL_HASH"]
event
required
array
["ONLINE"]
devices
required
array
["DESKTOP","MOBILE"]
notify_method
required
string
only value for now : WEBHOOK
name
required
string
campaign name
id_audience
required
string
audience id
Response
200: OK
    {
      "id": "xxxxxxx-2feb-481a-9910-6d71dc337b00",
      "id_audience": "xxxxxx-6e58-4db7-8ada-53b7bace6da4",
      "id_partner": 12345,
      "name": "My first campaign",
      "notify_method": "WEBHOOK",
      "devices": [
        "DESKTOP",
        "MOBILE"
      ],
      "event": [
        "ONLINE"
      ],
      "map_value_types": [
        "EMAIL_HASH"
      ],
      "active": true,
      "start": "2019-07-25T17:09:41.32419522+02:00",
      "end": "2019-09-30T00:09:41.32419522+02:00",
      "max_event_age_in_second": 300,
      "max_notifying_per_id": 1000,
      "delay_before_notify_same_id_in_second": 3600,
      "webhook_endpoint": "https://my-endpoint.com/api/v1/endpoint",
      "capping_notify_per_minute": null,
      "status_endpoint": null,
      "filter_partner_audience": true,
      "ready_for_activation": true,
      "uploaded_ids": 0
    }
400: Bad Request
​
put
Update campaign
https://partner-api.sddan.com/api/v1/public/event-notify/campaign/:id
Use same parameters as create campaign
Request
Response
Request
Path Parameters
id
required
string
campaign id
Headers
Authorization
optional
string
token
Response
200: OK
    {
      "id": "xxxxxxx-2feb-481a-9910-6d71dc337b00",
      "id_audience": "xxxxxx-6e58-4db7-8ada-53b7bace6da4",
      "id_partner": 12345,
      "name": "My first campaign",
      "notify_method": "WEBHOOK",
      "devices": [
        "DESKTOP",
        "MOBILE"
      ],
      "event": [
        "ONLINE"
      ],
      "map_value_types": [
        "EMAIL_HASH"
      ],
      "active": true,
      "start": "2019-07-25T17:09:41.32419522+02:00",
      "end": "2019-09-30T00:09:41.32419522+02:00",
      "max_event_age_in_second": 300,
      "max_notifying_per_id": 1000,
      "delay_before_notify_same_id_in_second": 3600,
      "webhook_endpoint": "https://my-endpoint.com/api/v1/endpoint",
      "capping_notify_per_minute": null,
      "status_endpoint": null,
      "filter_partner_audience": true,
      "ready_for_activation": true,
      "uploaded_ids": 0
    }
302: Found
​
404: Not Found
​
Notification API - Previous
Audience
Next - Notification API
Webhook endpoint
Last updated 2 months ago
Campaign

getCampaign list

getCampaign

postCreate campaign

putUpdate campaign

get
Campaign list

get
Campaign

post
Create campaign

put
Update campaign
