View, create and delete call to actions.
Create a new call to action
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
REQUEST
Content-Type: application/json
{
"chapter_id": 1024,
"second": 145,
"duration": 16,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>"
}
RESPONSE
201 (Created)
{
"chapter_id": 1024,
"second": 145,
"duration": 16,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>",
"id": 8192,
"created_at": 1374261385,
"updated_at": 1374261385
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
chapter_id required |
The chapter this call to action will be added to. Not passing this parameter will create a default event. Validations:
|
|
second required |
The start time of this call to action in seconds. Use Validations:
|
|
duration optional |
The duration this call to action will be displayed Validations:
|
|
auto_close optional |
The call to action will automatically close after the set duration Validations:
|
|
width required |
Width in pixels of the call to action popout Validations:
|
|
html required |
HTML this call to action will display. May include JavaScript and HTML forms. Validations:
|
Create a default email gate call to action
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
REQUEST
Content-Type: application/json
{
"chapter_id": 1024
}
RESPONSE
201 (Created)
{
"chapter_id": 1024,
"second": 0,
"duration": 1,
"auto_close": false,
"html": "<div class=\"main\">Enter your email to play the video</div>",
"id": 8192,
"created_at": 1374261385,
"updated_at": 1374261385
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
chapter_id required |
The chapter this call to action will be added to Validations:
|
|
is_closeable required |
Is the email gate optional? Validations:
|
|
is_new_contact required |
Is the email gate only for new contacts? Validations:
|
Update a call to action
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| 422 | Unprocessable Entity: body has wrong attributes |
REQUEST
Content-Type: application/json
{
"second": 4,
"duration": 4
}
RESPONSE
200 (OK)
{
"chapter_id": 1024,
"second": 4,
"duration": 4,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>",
"id": 8192,
"created_at": 1374261385,
"updated_at": 1374261385
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Validations:
|
|
second optional |
The start time of this call to action in seconds Validations:
|
|
duration optional |
The duration this call to action will be displayed Validations:
|
|
auto_close optional |
The call to action will automatically close after the set duration Validations:
|
|
width optional |
Width in pixels of the call to action popout Validations:
|
|
html optional |
HTML this call to action will display. May include JavaScript and HTML forms. Validations:
|
Get a single call to action
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
200 (OK)
{
"chapter_id": 1024,
"second": 145,
"duration": 16,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>",
"id": 8192,
"created_at": 1374261385,
"updated_at": 1374261385
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Used to uniquely identify a call to action Validations:
|
Get all popout call to actions for a chapter
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
{
"ctas": [
{
"chapter_id": 1024,
"second": 0,
"duration": 4,
"auto_close": true,
"width": 250,
"html": "<div class=\"main\">Enjoy the video</div>",
"id": 8233,
"created_at": 1374726233,
"updated_at": 1374835343
},
{
"chapter_id": 1024,
"second": 145,
"duration": 16,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>",
"id": 8192,
"created_at": 1374261385,
"updated_at": 1374261385
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 100
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Get all popout call to actions for a player
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
{
"ctas": [
{
"chapter_id": 1024,
"second": 0,
"duration": 4,
"auto_close": true,
"width": 250,
"html": "<div class=\"main\">Enjoy the video</div>",
"id": 8233,
"created_at": 1374726233,
"updated_at": 1374835343
},
{
"chapter_id": 1027,
"second": 145,
"duration": 16,
"auto_close": true,
"width": 300,
"html": "<div class=\"main\">Checkout my CTA!</div>",
"id": 7359,
"created_at": 1374261385,
"updated_at": 1374261385
}
],
"summary": {
"page": 1,
"per_page": 2,
"count": 100
}
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Used to uniquely identify a player Validations:
|
|
include_defaults optional |
Determines whether regular and default CTAs should both be returned. Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Get all popout call to actions for a player by UUID
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Used to uniquely identify a player Validations:
|
|
include_defaults optional |
Determines whether regular and default CTAs should both be returned. Validations:
|
|
per_page optional |
The number of items to show per page Validations:
|
|
page optional |
The page number to include in the response Validations:
|
Delete a call to action
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
{
"chapter_id": 1024,
"second": 0,
"duration": 4,
"auto_close": true,
"width": 250,
"html": "<div class=\"main\">Enjoy the video</div>",
"id": 8233,
"created_at": 1374726233,
"updated_at": 1374835343
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Used to uniquely identify a call to action Validations:
|
Get popout call to action meta data for a player
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
REQUEST
Accept: application/json
RESPONSE
{
"max_cta_width": 350,
"num_public_ctas": 11,
"num_draft_ctas": 2
}
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
id required |
Used to uniquely identify a player Validations:
|
Get popout call to action meta data for a player by UUID
| Code | Description |
|---|---|
| 400 | Bad Request: body has wrong syntax or unable to handle request |
| 401 | Unauthorized: auth_token omitted or authentication failed |
| 403 | Forbidden: This action cannot be performed |
| 404 | Not Found: The requested resource could not be found |
| 406 | Not Acceptable: Accept or Content-Type headers must be application/json, text/csv or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet |
| Param name | Description |
|---|---|
|
auth_token optional |
API token needed to authorize requests Validations:
|
|
uuid required |
Used to uniquely identify a player Validations:
|