CREATIVE MANAGEMENT API

INTRODUCTION

PulsePoint clients seeking enhanced creative management capabilities can now utilize the newly introduced Creative Management API. This API allows clients to effortlessly upload new creatives and modify existing ones directly through an ad server's user interface, eliminating the need to log into the PulsePoint platform.

Please note this API currently only supports HTML creatives.

Actions

Create a creative specific account
Get a creative by its ID
Update a creative
Assign creatives to a tactic

Important to Note:

Field	Mandatory	Expected Values
name	Y	String
creativeType	Y	Expandable / Html
advertiserName	Y	String
adSizeHeight	Y	Number
adSizeWidth	Y	Number
domainLandingPage	Y	String
adChoicesIcon	Y	TopRight, TopLeft, BottomRight, BottomLeft, None
creativeHtml	Y	String
notes		String
placementId		Number
campaignRestrictName		Valid Campaign Name
expandDirection (Expandable type)		Up, Down, Left, Right, Up Left, Up Right, Down Left, Down Right
categoryNames		Valid Category Name

The Creative Management API endpoints support 10 calls per minute

Endpoints

1. Create Creative

/v1/lifecreative/account/{accountId}

Example Request Body

{
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": ["Family & Parenting", "Personal Finance"]
}

REQUEST EXAMPLES

Below are a list of code examples for CURL, Python, Java and JavaScript

CURL

curl --location --request POST 'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer LFFqkw8CkqmbhITaS0oP1xDGAfk' \
--header 'Authorization: Bearer <token>' \
--data '{
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": ["Family & Parenting", "Personal Finance"]
}'

PYTHON

import requests
import json

url = "http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534"

payload = json.dumps({
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": [
    "Family & Parenting",
    "Personal Finance"
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <token>'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"testApr-10\",\n  \"creativeType\": \"html\",\n  \"advertiserName\": \"01- Advertiser\",\n  \"adSizeHeight\": 576,\n  \"adSizeWidth\": 1024,\n  \"domainLandingPage\": \"https://test.com/\",\n  \"adChoicesIcon\": \"TopRight\",\n  \"creativeHtml\": \"test-html\",\n  \"notes\": \"test-notes\",\n  \"placementId\": 123,\n  \"campaignRestrictName\": \"camp1_drug\",\n  \"categoryNames\": [\"Family & Parenting\", \"Personal Finance\"]\n}");
Request request = new Request.Builder()
  .url("http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();

JAVASCRIPT

const myHeaders = new Headers()
myHeaders.append('Content-Type', 'application/json')
myHeaders.append('Authorization', 'Bearer <token>')

const raw = JSON.stringify({
  name: 'testApr-10',
  creativeType: 'html',
  advertiserName: '01- Advertiser',
  adSizeHeight: 576,
  adSizeWidth: 1024,
  domainLandingPage: 'https://test.com/',
  adChoicesIcon: 'TopRight',
  creativeHtml: 'test-html',
  notes: 'test-notes',
  placementId: 123,
  campaignRestrictName: 'camp1_drug',
  categoryNames: ['Family & Parenting', 'Personal Finance'],
})

const requestOptions = {
  method: 'POST',
  headers: myHeaders,
  body: raw,
  redirect: 'follow',
}

fetch(
  'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534',
  requestOptions,
)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.error(error))

2. Get a creative by it's ID

/v1/lifecreative/{creativeId}

SAMPLE RESPONSE

{
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": ["Family & Parenting", "Personal Finance"]
}

REQUEST EXAMPLES

Below are a list of code examples for CURL, Python, Java and JavaScript

CURL

curl --location 'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534' \
--header 'Authorization: Bearer <token>'

PYTHON

import requests

url = "http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534"

payload = {}
headers = {
  'Authorization': 'Bearer <token>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534")
  .method("GET", body)
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();

JAVASCRIPT

const myHeaders = new Headers()
myHeaders.append('Authorization', 'Bearer <token>')

const requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow',
}

fetch(
  'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534',
  requestOptions,
)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.error(error))

3. Update a Creative

/v1/lifecreative/{creativeId}

Example Request Body

{
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": ["Family & Parenting", "Personal Finance"]
}

REQUEST EXAMPLES

Below are a list of code examples for CURL, Python, Java and JavaScript

CURL

curl --location --request PUT 'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer LFFqkw8CkqmbhITaS0oP1xDGAfk' \
--header 'Authorization: Bearer <token>' \
--data '{
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": ["Family & Parenting", "Personal Finance"]
}'

PYTHON

import requests
import json

url = "http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534"

payload = json.dumps({
  "name": "testApr-10",
  "creativeType": "html",
  "advertiserName": "01- Advertiser",
  "adSizeHeight": 576,
  "adSizeWidth": 1024,
  "domainLandingPage": "https://test.com/",
  "adChoicesIcon": "TopRight",
  "creativeHtml": "test-html",
  "notes": "test-notes",
  "placementId": 123,
  "campaignRestrictName": "camp1_drug",
  "categoryNames": [
    "Family & Parenting",
    "Personal Finance"
  ]
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <token>'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n  \"name\": \"testApr-10\",\n  \"creativeType\": \"html\",\n  \"advertiserName\": \"01- Advertiser\",\n  \"adSizeHeight\": 576,\n  \"adSizeWidth\": 1024,\n  \"domainLandingPage\": \"https://test.com/\",\n  \"adChoicesIcon\": \"TopRight\",\n  \"creativeHtml\": \"test-html\",\n  \"notes\": \"test-notes\",\n  \"placementId\": 123,\n  \"campaignRestrictName\": \"camp1_drug\",\n  \"categoryNames\": [\"Family & Parenting\", \"Personal Finance\"]\n}");
Request request = new Request.Builder()
  .url("http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();

JAVASCRIPT

const myHeaders = new Headers()
myHeaders.append('Content-Type', 'application/json')
myHeaders.append('Authorization', 'Bearer <token>')

const raw = JSON.stringify({
  name: 'testApr-10',
  creativeType: 'html',
  advertiserName: '01- Advertiser',
  adSizeHeight: 576,
  adSizeWidth: 1024,
  domainLandingPage: 'https://test.com/',
  adChoicesIcon: 'TopRight',
  creativeHtml: 'test-html',
  notes: 'test-notes',
  placementId: 123,
  campaignRestrictName: 'camp1_drug',
  categoryNames: ['Family & Parenting', 'Personal Finance'],
})

const requestOptions = {
  method: 'PUT',
  headers: myHeaders,
  body: raw,
  redirect: 'follow',
}

fetch(
  'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/5534',
  requestOptions,
)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.error(error))

4. Assign Creatives to Tactic

Field	Mandatory	Expected Values
tacticId	Y	Number (A Valid Tactic ID)
creativesToAssign		Array of Numbers (A Valid Creative ID)
		Ex: `[205581]`
creativesToUnAssign		Array of Numbers (A Valid Creative ID)
		Ex: `[207561, 213290]`

/v1/lifecreative/account/{accountId}/creativeassociation

Example Request Body

[
  {
    "tacticId": 123425,
    "creativesToAssign": [2055812]
  },
  {
    "tacticId": 65465,
    "creativesToUnAssign": [207561, 213290]
  },
  {
    "tacticId": 878545,
    "creativesToAssign": [205581],
    "creativesToUnAssign": [207561, 213290]
  }
]

REQUEST EXAMPLES

Below are a list of code examples for CURL, Python, Java and JavaScript

CURL

curl --location --request PUT 'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/account/123456/creativeassociation' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <token>' \
--data '[{
    "tacticId" : 123425,
    "creativesToAssign" : [2055812]
},
{
    "tacticId" : 65465,
    "creativesToUnAssign" : [207561, 213290]
},
{
    "tacticId" : 878545,
    "creativesToAssign" : [205581],
    "creativesToUnAssign" : [207561, 213290]
}]
'

PYTHON

import requests
import json

url = "http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/account/123456/creativeassociation"

payload = json.dumps([
  {
    "tacticId": 123425,
    "creativesToAssign": [
      2055812
    ]
  },
  {
    "tacticId": 65465,
    "creativesToUnAssign": [
      207561,
      213290
    ]
  },
  {
    "tacticId": 878545,
    "creativesToAssign": [
      205581
    ],
    "creativesToUnAssign": [
      207561,
      213290
    ]
  }
])
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer <token>'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

JAVA

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "[{\n    \"tacticId\" : 123425,\n    \"creativesToAssign\" : [2055812]\n},\n{\n    \"tacticId\" : 65465,\n    \"creativesToUnAssign\" : [207561, 213290]\n},\n{\n    \"tacticId\" : 878545,\n    \"creativesToAssign\" : [205581],\n    \"creativesToUnAssign\" : [207561, 213290]\n}]\n");
Request request = new Request.Builder()
  .url("http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/account/123456/creativeassociation")
  .method("PUT", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer <token>")
  .build();
Response response = client.newCall(request).execute();

JAVASCRIPT

const myHeaders = new Headers()
myHeaders.append('Content-Type', 'application/json')
myHeaders.append('Authorization', 'Bearer <token>')

const raw = JSON.stringify([
  {
    tacticId: 123425,
    creativesToAssign: [2055812],
  },
  {
    tacticId: 65465,
    creativesToUnAssign: [207561, 213290],
  },
  {
    tacticId: 878545,
    creativesToAssign: [205581],
    creativesToUnAssign: [207561, 213290],
  },
])

const requestOptions = {
  method: 'PUT',
  headers: myHeaders,
  body: raw,
  redirect: 'follow',
}

fetch(
  'http://lifeapi.pulsepoint.com/RestApi/v1/lifecreative/account/123456/creativeassociation',
  requestOptions,
)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.error(error))

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

README.md

README.md

CREATIVE MANAGEMENT API

INTRODUCTION

Actions

Endpoints

1. Create Creative

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT

2. Get a creative by it's ID

SAMPLE RESPONSE

CURL

PYTHON

JAVA

JAVASCRIPT

3. Update a Creative

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT

4. Assign Creatives to Tactic

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT

Files

README.md

Latest commit

History

README.md

File metadata and controls

CREATIVE MANAGEMENT API

INTRODUCTION

Actions

Endpoints

1. Create Creative

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT

2. Get a creative by it's ID

SAMPLE RESPONSE

CURL

PYTHON

JAVA

JAVASCRIPT

3. Update a Creative

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT

4. Assign Creatives to Tactic

Example Request Body

CURL

PYTHON

JAVA

JAVASCRIPT