Asset Library
Overview
These APIs allow you to manage assets (files, zip uploads, and folders) within an account. You can get assets, upload files, check upload status, or delete assets/folders from the asset library.
For information on Generating API key, see "Generating API Key" in https://docs.jivox.com/jivox-documentation/generate-api-key
Method Name | Method Type | Description |
|---|---|---|
GET | Retrieves a list of files and folders in the account's asset library. | |
POST | Uploads a file or zip to the asset library. | |
GET | Retrieves detailed status of an asset upload queue. | |
GET | Retrieves summary status of an upload queue. | |
DELETE | Deletes a file or folder in the asset library. |
Get Assets
Get assets for a given user account.
End Point
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
accountId | Integer | Mandatory | path | ID of the advertiser account created on the platform. |
nextKey | String | Optional | query | Pagination key for results |
limit | Integer | Optional | query | Number of items per page |
prefix | String | Optional | query | List assets under given prefix/path |
Path and filename validations apply
Sample Request
Sample Response
If there is no next page, nextKey would be null.
Upload File/Zip to Asset Library
Upload files or zip to Asset Library.
End Point
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
accountId | String | Mandatory | path | ID of the advertiser account created on the platform. |
Sample Request
Request Body (Multipart Form)
Name | Data Type | Requirement | Example | Description |
|---|---|---|---|---|
file | File | Mandatory | test.png, assets.zip | File or zip to upload |
path | String | Optional | test/uploads/ | Folder path where file should go |
Upload Constraints
Maximum file size: 10 MB
Only one file per upload request: If multiple files are attached, only the first file is processed
Path and filename validations apply
Allowed File Types
Category | Extensions |
|---|---|
Images | jpg, jpeg, png, gif, webp, svg, bmp, tiff, ico |
Documents | pdf, doc, docx, xls, xlsx, ppt, pptx, txt, rtf, csv |
Media | mp4, avi, mov, wmv, flv, webm, mkv, mp3, wav, ogg, m4a |
Web Files | html, htm, css, js, json, xml |
Fonts | ttf, otf, woff, woff2 |
Archives | zip (will be extracted) |
Sample Response
Get Upload Detailed Status
End Point
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
queueId | String | Mandatory | path | Queue id received from upload request. |
Sample Request
Sample Response
Get Upload Status
End Point
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
queueId | String | Mandatory | path | Queue id received from upload request. |
Example/Sample Request
Sample Response
Delete Assets/Asset Folders
End Point
Parameters
Name | Data Type | Requirement | Parameter Type | Description |
|---|---|---|---|---|
accountId | Integer | Mandatory | path | ID of the advertiser account created on the platform. |
path | String | Mandatory(optional for file delete) | query | Path of folder or file to delete |
command | String | Mandatory | query | Command specifying deletion action
|
file | String | Mandatory(optional for folder delete) | query | File name if deleting a specific file |
Example/Sample Request
Delete File
Optional : path
Mandatory:
OR
Delete Folder
Mandatory:
Sample Response
Deleting a non-existent file is considered a success operation.
If all the files inside a path are deleted, that path would also be removed.
Path and filename Validation Rules
Max path length: 512 characters
Null byte (
\\u0000) and ASCII control chars (0x00–0x1F) not allowedUnicode control chars disallowed: DEL (
\\u007F), NEL (\\u0085), Latin-1 Supplement (U+00A0–U+00FF)Paths cannot contain traversal sequences such as
".."or"./"Paths cannot start with
/(no absolute paths)Paths cannot contain double slashes
"//"File names must not end with
/File extension must be in the allowed file types list
Examples of Validation Errors
Path contains a null byte (\\u0000).Path exceeds max length of 512 characters.Path contains illegal sequence ".." (directory traversal).File extension 'exe' is not allowed. Allowed: jpg, png, pdf, ...