Jivox API Documentation
v1.0
GenAI & Template Generation
Title
Message
Create new category
What is the title of your new category?
Edit page index title
What is the title of the page index?
Edit category
What is the new title of your category?
Edit link
What is the new title and URL of your link?
Media Channels
Copy Markdown
Open in ChatGPT
Open in Claude
The various methods for Media Channels are listed below:
- Get all media channels by account (template campaign)
- Create media channels
- Update media channel
- Get all media channels (by org)
- Get media channel configuration (by org)
- Delete media channel
Get all media channels by account (template campaign)
Returns all media channels associated with a specific template campaign under an account. The account must belong to a Retailer Org. Supports pagination via ParamInfo.
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| accountId | string | Mandatory | path | ID of the account (must belong to a Retailer Org). |
| templateCampaignIdx | integer | Mandatory | path | Index of the template campaign. |
Query Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| offset | integer | Optional | query | Pagination offset (e.g. 0). |
| limit | integer | Optional | query | Number of items per page (e.g. 25). |
Sample Response
Returns a paginated JSON object with a mediaChannels array. The pagination fields (count, next, previous) are controlled by ParamInfo (default: offset=0, limit=25).
| Field | Data Type | Description |
|---|---|---|
| mediaChannels | array | List of media channel objects |
| mediaChannels[].idx | integer | Unique index of the media channel |
| mediaChannels[].name | string | Name of the media channel |
| mediaChannels[].adServerId | string | ID of the associated ad server |
| mediaChannels[].adServerName | string/null | Name of the associated ad server |
| mediaChannels[].status | enum (string) | Status of the media channel. Values: Enabled, Disabled, Deleted |
| mediaChannels[].type | string | Type of the media channel (from MediaChannelType). |
| mediaChannels[].logoUrl | string/null | URL of the media channel logo |
| mediaChannels[].activationConfiguration | object | Activation settings for the media channel. |
| mediaChannels[].activationConfiguration.tagGeneration | boolean | Whether tag generation is enabled |
| mediaChannels[].activationConfiguration.creativeGeneration | boolean | Whether creative generation is enabled. |
| mediaChannels[].additionalConfiguration | string/null | Additional configuration (JSON string or null). |
| mediaChannels[].isUtilized | boolean/null | Whether the media channel is currently in use. |
| count | integer | Total number of matching media channels. |
| next | string/null | URL for the next page of results. |
| previous | string/null | URL for the previous page of results. |
Sample Request
HTTP
GET https://jivoxapis.api.jivox.com/v2/accounts/:accountId/template-campaigns/:templateCampaignIdx/retail-media-channelsRequest Body
JSON
{ "mediaChannels": [ { "idx": 101, "name": "Walmart DSP", "adServerId": "walmart-dsp-001", "adServerName": "Walmart DSP Server", "status": "Enabled", "type": "DSP", "logoUrl": "https://cdn.example.com/logos/walmart.png", "activationConfiguration": { "tagGeneration": true, "creativeGeneration": false }, "additionalConfiguration": null, "isUtilized": true } ], "count": 1, "next": null, "previous": null}Create media channels
Creates a new media channel for a retailer org. Requires MediaChannel_All permission.
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the retailer org. |
Parameters
| Field | Data Type | Requirement | Description |
|---|---|---|---|
| name | string | Mandatory | Display name of the media channel. |
| adServerId | string | Mandatory | ID of the ad server associated with this channel. |
| type | enum (string) | Mandatory | Channel type. Values: On-site, Off-site, Social, In-store/DOOH, Hybrid. |
| activationConfiguration | object | Mandatory | Controls how the channel is activated |
| activationConfiguration.tagGeneration | boolean | Mandatory | Whether tag generation is enabled for this channel. |
| activationConfiguration.creativeGeneration | boolean | Mandatory | Whether creative generation is enabled for this channel. |
| additionalConfiguration | object | Optional | Arbitrary JSON object for channel-specific additional settings (e.g. DSP configuration). |
Sample Request
HTTP
POST https://jivoxapis.api.jivox.com/v2/org/:orgId/retail-media-channelsRequest Body
JSON
{ "name": "Amazon DSP - US", "adServerId": "amazon-dsp-001", "type": "On-site", "activationConfiguration": { "tagGeneration": true, "creativeGeneration": true }, "additionalConfiguration": { "region": "us-east-1", "accountId": "acc-123" }}Sample Response
JSON
{ "idx": 101, "message": "Media channel created successfully"}Update media channel
Updates an existing media channel for a retailer org. Requires MediaChannel_All permission.
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the retailer org |
| mediaChannelIdx | integer | Mandatory | path | Index of the media channel to update |
Parameters
| Field | Data Type | Requirement | Description |
|---|---|---|---|
| status | string | Optional | New status for the channel (e.g. Active, Inactive) |
| activationConfiguration | object | Optional | Updated activation configuration |
| activationConfiguration.tagGeneration | boolean | Optional | Whether tag generation is enabled |
| activationConfiguration.creativeGeneration | boolean | Optional | Whether creative generation is enabled |
| additionalConfiguration | object | Optional | Updated arbitrary JSON object for channel-specific settings |
Sample Request
HTTP
PUT https://jivoxapis.api.jivox.com/v2/org/:orgId/retail-media-channels/:mediaChannelIdxRequest Body
JSON
{ "status": "Active", "activationConfiguration": { "tagGeneration": true, "creativeGeneration": false }, "additionalConfiguration": { "region": "us-west-2" }}Sample Response
JSON
{ "message": "Media channel updated successfully"}Get all media channels (by org)
Returns a paginated list of all media channels for a retailer org. Requires MediaChannel_All permission.
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the retailer org. |
Query Parameters
| Name | Data Type | Requirement | Default | Description |
|---|---|---|---|---|
| offset | integer | Optional | 0 | Number of records to skip. |
| limit | integer | Optional | 25 | Maximum number of records to return. |
Sample Response
Returns a paginated MediaChannelListResponse object.
| Field | Data Type | Description |
|---|---|---|
| mediaChannels | array | List of media channel objects |
| mediaChannels[].idx | integer | Internal index of the media channel. |
| mediaChannels[].name | string | Display name of the media channel. |
| mediaChannels[].adServerId | string | ID of the associated ad server |
| mediaChannels[].adServerName | string/null | Display name of the associated ad server. |
| mediaChannels[].status | string | Current status of the channel. |
| mediaChannels[].type | string | Channel type value (e.g. On-site, Off-site, Social, In-store/DOOH, Hybrid). |
| mediaChannels[].logoUrl | string/null | URL of the channel logo. |
| mediaChannels[].additionalConfiguration | string/null | JSON string of additional configuration for the channel. |
Sample Request
HTTP
GET https://jivoxapis.api.jivox.com/v2/org/:orgId/retail-media-channels?offset=0&limit=25Request Body
JSON
{ "mediaChannels": [ { "idx": 101, "name": "Amazon DSP - US", "adServerId": "amazon-dsp-001", "adServerName": "Amazon DSP", "status": "Active", "type": "On-site", "logoUrl": "https://cdn.jivox.com/logos/amazon-dsp.png", "additionalConfiguration": "{\"region\":\"us-east-1\"}" } ], "total": 1, "next": null, "previous": null}Get media channel configuration (by org)
Returns the stored configuration details for a specific media channel. Requires MediaChannel_All permission..
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the retailer org. |
| mediaChannelIdx | integer | Mandatory | path | Index of the media channel. |
Sample Response
| Field | Data Type | Description |
|---|---|---|
| mediaChannelInfo | object | Parsed JSON object containing the full media channel configuration details |
Sample Request
HTTP
GET https://jivoxapis.api.jivox.com/v2/org/:orgId/retail-media-channels/:mediaChannelIdxRequest Body
JSON
{ "mediaChannelInfo": { "idx": 101, "name": "Amazon DSP - US", "adServerId": "amazon-dsp-001", "type": "On-site", "status": "Active", "activationConfiguration": { "tagGeneration": true, "creativeGeneration": true }, "additionalConfiguration": { "region": "us-east-1", "accountId": "acc-123" }, "updatedTime": "2024-05-10T09:00:00.000Z" }}Delete media channel
Deletes a media channel from a retailer org. Requires MediaChannel_All permission.
Path Parameters
| Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
| orgId | string | Mandatory | path | ID of the retailer org. |
| mediaChannelIdx | integer | Mandatory | path | Index of the media channel to delete |
Sample Request
HTTP
DELETE https://jivoxapis.api.jivox.com/v2/org/:orgId/retail-media-channels/:mediaChannelIdxSample Response
JSON
{ "message": "Media channel deleted successfully"}Type to search, ESC to discard
Type to search, ESC to discard
Type to search, ESC to discard
Last updated on
Was this page helpful?
Next to read:
Carousel APIDiscard Changes
Do you want to discard your current changes and overwrite with the template?
Archive Synced Block
Message
Create new Template
What is this template's title?
Delete Template
Message