Deprecation Warning
DSP API v1 will continue to receive critical bug and security fixes, but no new functionality will be added going forward. Next version of DSP API is under development and when ready DSP API v1 will be deprecated.
Client
Clients represent customers for which advertising activities can be configured.
Contact your Delta Projects representative to get your
mediaAgencyId!
List Clients
Description: List all available clients
Verb: GET
Path: /api/v1/media_agency/<mediaAgencyId>/client
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
mediaAgencyId |
Path | Yes | Id of media agency | 86b35325-794c-11e4-8425-daf437376f87 |
apikey |
Query | Yes | API key for authentication and authorization | secretkey123 |
Response JSON Body
| Parameter | Parameter Type | Description | Example |
|---|---|---|---|
top level |
Array of Client | Clients | See below |
Client Object
| Parameter | Parameter Type | Description | Example |
|---|---|---|---|
id |
String | Id of client | 86b35326-794c-11e4-8425-daf437376f87 |
name |
String | Name of client | Example Client |
Example Request
GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client?apikey=secret123
Example Response
[
{
"id": "86b35326-794c-11e4-8425-daf437376f87",
"name": "Example Client"
}
]
Retrieve Client
Description: Retrieve given client
Verb: GET
Path: /api/v1/client/<clientId>
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
clientId |
Path | Yes | Id of client | 86b35326-794c-11e4-8425-daf437376f87 |
apikey |
Query | Yes | API key for authentication and authorization | secretkey123 |
fetch |
Query | No | child entities to attach | campaigns.activities |
Response JSON Body
| Parameter | Parameter Type | Description | Example |
|---|---|---|---|
id |
String | Id of client | 86b35326-794c-11e4-8425-daf437376f87 |
name |
String | Name of client | Example Client |
country |
String | Country of client | SE |
currency |
String | Currency of client budgets etc | EUR |
Example Request
GET /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87?apikey=secret123
Example Response
{
"id": "86b35326-794c-11e4-8425-daf437376f87",
"name": "Example Client",
"country": "SE",
"currency": "EUR"
}
Create Client
Description: Create a new client
Verb: POST
Path: /api/v1/media_agency/<mediaAgencyId>/client/create_from_template
Request Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
mediaAgencyId |
Path | Yes | Id of media agency | 86b35325-794c-11e4-8425-daf437376f87 |
apikey |
Query | Yes | API key for authentication and authorization | secretkey123 |
Request JSON body
| Parameter | Parameter Type | Required | Description | Example |
|---|---|---|---|---|
templateId |
String | Yes | Id of client template | 16b35326-794c-11e4-8425-daf437376f87 |
clientName |
String | Yes | Name of client to be created | Example Client" |
Response
HTTP 201 Created with the URL to the created client in the Location header.
Example Request
POST /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/create_from_template?apikey=secret123
Example Request Body
{
"templateId": "16b35326-794c-11e4-8425-daf437376f87",
"clientName": "Example Client"
}
Example Response
Location: /api/v1/media_agency/86b35325-794c-11e4-8425-daf437376f87/client/86b35326-794c-11e4-8425-daf437376f87
Last modified: Mon Sep 23 2024 11:48:54 GMT+0200 (Central European Summer Time)