Create a Profile List with or without brand Context
You can use this API endpoint to create a profile list. The list can contain the fields you specify in the request. For Multi-brand enabled accounts, you can use this request to create a branded profile list.
Note: The Responsys Advanced API is generally available for all Responsys customers.
Service URL:
/rest/api/v1.3/lists
Request Method:
POST
Request Header:
Authorization=<AUTH_TOKEN>
Content-Type=application/json
Request Body:
Refer to the online REST API reference for an explanation of each parameter. You can also refer to Profile List standard fields to determine the field names and field types to specify for your profile list.
{
"listName": "abc",
"listFolderName": "xyz",
"description": "description about the profile list.",
"brandName": "brand1",
"fields": [
{
"fieldName": "custom1",
"fieldType": "CHAR"
},
{
"fieldName": "custom2",
"fieldType": "STR50"
}
]
}
Sample Response in case of success:
{
"listName": "abc ",
"message": "List Has Been Created."
}
Sample Responses in case of failures
List already exists: Requests fail if a profile list with the specified name already exists. The error resembles:
{
"type": "",
"title": "List already exists",
"errorCode": "LIST_ALREADY_EXISTS",
"detail": "List already exists.",
"errorDetails": []
}
Brand name not found: Requests fail if specifying a brand and the brand name cannot be found. The error resembles:
{
"type": "",
"title": "Record not found",
"errorCode": "RECORD_NOT_FOUND",
"detail": "List already exists.",
"errorDetails": []
}
Folder not found: Requests fail if the folder name specified cannot be found. The error resembles:
{
"type": "",
"title": "Record not found",
"errorCode": "FOLDER_NOT_FOUND",
"detail": "Folder [Folder_name] not found",
"errorDetails": []
}
Invalid folder name: Requests fail if the folder name contains an invalid character. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Invalid Folder Name in the Request",
"errorDetails": []
}
Invalid List Name: Requests fail if the ListName is not provided. The error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Invalid List Name in the Request",
"errorDetails": []
}
Invalid field types: Requests will fail if invalid field types are specified in the request. Field types must be one of: CHAR, STR25, STR100, STR500, STR4000, NUMBER, INTEGER, or TIMESTAMP. Error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Invalid List Name in the Request",
"errorDetails": []
}
List name more than characters defined in account settings: Requests will fail if the list name exceeds the account settings character limit. Error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Max Length of listName allowed: 10",
"errorDetails": []
}
Max number of custom fields allowed: Requests will fail if more than 5 custom fields are included. Error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Max No. of custom fields allowed :5",
"errorDetails": []
}
API limit exceeded: When the client application exceeds the throttling limit for this API, a 401 Unauthorized error is returned with the following error response body. Refer to Get Throttling Limits to learn more. Error resembles:
{
"type": "",
"title": "Invalid request parameters",
"errorCode": "INVALID_PARAMETER",
"detail": "Max No. of custom fields allowed :5",
"errorDetails": []
}
Invalid field name: Requests fail if any field names provided are invalid.
{
"type": "",
"title": "Invalid field name",
"errorCode": "INVALID_FIELD_NAME",
"detail": "The following field names [invalid_field_names_list] are invalid",
"errorDetails": []
}