Create a Folder
post
/rest/api/v1.3/folders
Creates a new folder in Oracle Responsys.
Request
Supported Media Types
- application/json
Request Body
Root Schema : Create Folder Request
Type:
object
Title:
Show Source
Create Folder Request
-
folderName(optional):
string
Name of the folder to create.
Response
Supported Media Types
- application/json
Default Response
Root Schema : Create Folder Response
Type:
object
Title:
Show Source
Create Folder Response
-
errorMessage(optional):
string
Error message if folder creation fails.
-
folderId(optional):
string
ID of the new folder.
-
success(optional):
boolean
Returns
true
if folder created successfully,false
otherwise
Examples
Create a folder in your Responsys account.
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
Sample Request:
Create a folder.
/rest/api/v1.3/folders
Sample Request Body:
{ "folderName": "FolderName" }
Sample Response: Success
{ "success": true, "folderId": 90087147, "errorMessage": null }
Example Responses: Failures
Invalid folder name: Requests fail if the folder name specified is invalid. The folder name must consist of the characters A-Z a-z 0-9 space ! - = @ _ [ ] { }. The error resembles:
{ "type": "", "title": "Invalid request parameters", "errorCode": "INVALID_PARAMETER", "detail": "Invalid Folder Name in the Request", "errorDetails": [] }
Folder already exists: Requests fail if the folder name specified already exists in Responsys. The error resembles:
{ "type": "", "title": "Folder already exists", "errorCode": "FOLDER_ALREADY_EXISTS", "detail": "Folder [ Folder_Name ] already exists.", "errorDetails": [] }
Maximum length of folder name: Requests fail if the folder name specified exceeds 100 characters. The error resembles:
{ "type": "", "title": "Invalid request parameters", "errorCode": "INVALID_PARAMETER", "detail": "Max Length of folderName allowed: 100", "errorDetails": [] }
Insufficient role: Requests fail if the user performing the request does not have the Folder Web Services Manager role. The error resembles:
{ "type": "", "title": "Insufficient access", "errorCode": "INSUFFICIENT_ACCESS", "detail": "Insufficient privileges to invoke this API", "errorDetails": [] }