Ads
20 routes. Paths are relative to https://api.intersink.com/v1. This group belongs to a feature in beta.
- PATCH/ads/ads/{id}Change or pause an ad
- DELETE/ads/ads/{id}Remove an ad
- GET/ads/businesses/{businessId}/campaignsThe business's campaigns, ads and last 30 days' results
- POST/ads/businesses/{businessId}/campaignsStart a campaign (draft) promoting one of the business's channels
- GET/ads/campaigns/{id}One campaign with its ads and results
- PATCH/ads/campaigns/{id}Change budget, bid, dates (at once) or audience (back to review)
- POST/ads/campaigns/{id}/adsAdd an ad (a running campaign goes back to review)
- POST/ads/campaigns/{id}/archiveArchive a campaign
- POST/ads/campaigns/{id}/pausePause a running campaign
- POST/ads/campaigns/{id}/resumeResume a paused campaign
- GET/ads/campaigns/{id}/statsResults per ad and day (last 30 days)
- POST/ads/campaigns/{id}/submitSend for review (accepts the advertising policy)
- GET/ads/channels/{channelId}/partnerThe channel's ad partner enrolment, this month's results and statements
- POST/ads/channels/{channelId}/partnerEnrol the channel in the Ad Partner Program (reviewed by Intersink)
- PATCH/ads/channels/{channelId}/partnerChange how the platform is described
- POST/ads/channels/{channelId}/partner/leaveLeave the Ad Partner Program
- GET/ads/click/{id}Follow an ad (counts the click, then redirects)
- GET/ads/libraryAd Library: every ad an advertiser has run (?q=business or brand)
- GET/ads/platformsPartner platforms advertisers can choose (Svayam's first)
- GET/ads/serveAds for a Sponsored slot on a partner platform (?partner=<its channel id>&country=)
Change or pause an ad
PATCH/ads/ads/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| headline | string | At least 2 characters, at most 60 characters. |
| body | string | At least 0 characters, at most 140 characters. |
| image_url | string | https image address At least 0 characters, at most 500 characters. |
| destination_url | string | A page on the promoted channel (https) At least 8 characters, at most 500 characters. |
| cta | string | One of: "learn_more", "shop_now", "book_now", "sign_up", "contact_us", "get_offer". |
| status | string | One of: "active", "paused". |
Response
200. The payload in data is of type object.
Remove an ad
DELETE/ads/ads/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
The business's campaigns, ads and last 30 days' results
GET/ads/businesses/{businessId}/campaigns
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Response
200. data is object[].
Start a campaign (draft) promoting one of the business's channels
POST/ads/businesses/{businessId}/campaigns
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| businessIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| channel_id | string | The business's own channel to promote |
| name | string | At least 2 characters, at most 120 characters. |
| objective | string | One of: "traffic", "sales", "leads", "awareness". |
| daily_budget_minor | number | Daily budget in minor units (pence/cents) Minimum 1, maximum 10000000. |
| max_cpc_minor | number | Highest cost per click in minor units Minimum 1, maximum 10000. |
| start_at | string | |
| end_at | string | |
| countries | string[] | Empty: everywhere |
| partner_ids | string[] | Partner platforms (channel ids) to run on; empty: every partner platform |
Response
200. The payload in data is of type object.
One campaign with its ads and results
GET/ads/campaigns/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
Change budget, bid, dates (at once) or audience (back to review)
PATCH/ads/campaigns/{id}
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| channel_id | string | The business's own channel to promote |
| name | string | At least 2 characters, at most 120 characters. |
| objective | string | One of: "traffic", "sales", "leads", "awareness". |
| daily_budget_minor | number | Daily budget in minor units (pence/cents) Minimum 1, maximum 10000000. |
| max_cpc_minor | number | Highest cost per click in minor units Minimum 1, maximum 10000. |
| start_at | string | |
| end_at | string | |
| countries | string[] | Empty: everywhere |
| partner_ids | string[] | Partner platforms (channel ids) to run on; empty: every partner platform |
Response
200. The payload in data is of type object.
Add an ad (a running campaign goes back to review)
POST/ads/campaigns/{id}/ads
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| headline | string | At least 2 characters, at most 60 characters. |
| body | string | At least 0 characters, at most 140 characters. |
| image_url | string | https image address At least 0 characters, at most 500 characters. |
| destination_url | string | A page on the promoted channel (https) At least 8 characters, at most 500 characters. |
| cta | string | One of: "learn_more", "shop_now", "book_now", "sign_up", "contact_us", "get_offer". |
| status | string | One of: "active", "paused". |
Response
200. The payload in data is of type object.
Archive a campaign
POST/ads/campaigns/{id}/archive
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is not described in the spec yet.
Pause a running campaign
POST/ads/campaigns/{id}/pause
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
Resume a paused campaign
POST/ads/campaigns/{id}/resume
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. The payload in data is of type object.
Results per ad and day (last 30 days)
GET/ads/campaigns/{id}/stats
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Response
200. data is object[].
Send for review (accepts the advertising policy)
POST/ads/campaigns/{id}/submit
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| accept_policyrequired | boolean | Accepts the advertising policy |
Response
200. The payload in data is of type object.
The channel's ad partner enrolment, this month's results and statements
GET/ads/channels/{channelId}/partner
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is of type object.
Enrol the channel in the Ad Partner Program (reviewed by Intersink)
POST/ads/channels/{channelId}/partner
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| platform_name | string | At least 2 characters, at most 80 characters. Example: "viremail" |
| description | string | At least 0 characters, at most 500 characters. |
| site_url | string | At least 0 characters, at most 300 characters. Example: "https://viremail.com" |
| category | string | One of: "email", "social", "browser", "news", "shopping", "video", "tools", "community", "other". |
| monthly_visitors | number | About how many people visit a month Minimum 0. |
| accept_termsrequired | boolean | Accepts the Ad Partner Terms |
Response
200. The payload in data is of type object.
Change how the platform is described
PATCH/ads/channels/{channelId}/partner
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Request body application/json
| Field | Type | Description |
|---|---|---|
| platform_name | string | At least 2 characters, at most 80 characters. Example: "viremail" |
| description | string | At least 0 characters, at most 500 characters. |
| site_url | string | At least 0 characters, at most 300 characters. Example: "https://viremail.com" |
| category | string | One of: "email", "social", "browser", "news", "shopping", "video", "tools", "community", "other". |
| monthly_visitors | number | About how many people visit a month Minimum 0. |
Response
200. The payload in data is of type object.
Leave the Ad Partner Program
POST/ads/channels/{channelId}/partner/leave
Needs a signed-in user (Bearer token or access_token cookie).
Parameters
| Name | Type | Description |
|---|---|---|
| channelIdrequired | string, path |
Response
200. The payload in data is of type object.
Follow an ad (counts the click, then redirects)
GET/ads/click/{id}
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| idrequired | string, path | |
| trequired | string, query | |
| prequired | string, query |
Response
200. The payload in data is not described in the spec yet.
Ad Library: every ad an advertiser has run (?q=business or brand)
GET/ads/library
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| qrequired | string, query | A business or brand name At least 2 characters, at most 80 characters. |
Response
200. The payload in data is not described in the spec yet.
Partner platforms advertisers can choose (Svayam's first)
GET/ads/platforms
Needs a signed-in user (Bearer token or access_token cookie).
Response
200. The payload in data is not described in the spec yet.
Ads for a Sponsored slot on a partner platform (?partner=<its channel id>&country=)
GET/ads/serve
Public: no sign-in needed.
Parameters
| Name | Type | Description |
|---|---|---|
| partnerrequired | string, query | The partner platform's channel id (the slot's owner) |
| country | string, query | At least 2 characters, at most 2 characters. Example: "GB" |
| limit | number, query | Minimum 1, maximum 6. |
Response
200. data is object[].