Skip to end of metadata
Go to start of metadata

Targeting Level

The Targeting Level Service returns all targeting levels for the caller's member. 

REST API

Get all targeting levels. 

Create a new targeting level. 

Update an existing targeting level.

Delete an existing targeting level. 

GET

Get all targeting levels for the caller's member. Results are returned as JSON. 

Example call using cURL.

Response:

On success, a JSON array containing targeting-level objects is returned.

PropertyTypeDescription
deletedbooleanIndicates if the current targeting level has been deleted.
idintegerA unique identifier for the targeting level.
last_modifiedstringThe most recent modification date of the targeting level.
namestringThe name of the targeting level.

Example JSON response: 

POST

Enables the creation of a new targeting level object.  

Example call using cURL. 

Parameters:

NameTypeScopeDescription
name
stringRequiredThe name of the targeting level.

Example JSON file: 

Response: 

On success, the new targeting level object is returned.

Properties:

FieldTypeDescription
deleted
booleanIndicates if the targeting level has been deleted.
id
integerA unique identifier for the targeting level.
last_modified
stringThe last date the targeting level was modified.
name
stringThe name of the targeting level.

PUT

Update an existing targeting level. Append the targeting level's id as the last URL path component. 

Example call using cURL. 

Parameters:

NameTypeScopeDescription
name
stringRequired

The name of the targeting level.

Example JSON file: 

Response: 

On success, the new targeting level object is returned.

Properties:

FieldTypeDescription
deleted
booleanIndicates if the targeting level has been deleted.
id
integerA unique identifier for the targeting level.
last_modified
stringThe last date the targeting level was modified.
name
stringThe name of the targeting level.

Example Response

 


DELETE

Delete an existing targeting level. Append the targeting level's id as the last URL path component.

Example call using cURL. 

On success the targeting level object is returned with deleted set to true. The targeting level object  will no longer be available in the system. 

  • No labels