Create Customer List

POST /customer-lists
Copied
Arrow
                https://api.ocamba.com/v1/hood/customer-lists

Creates a new Customer List

Request Body Schema
Arrow
Name
Description
colorstring
Describes the customer list color. Must respect the hexcolof format. Default value is '#ffffff' or white.


Example: #6d9382
descriptionstring
The more detailed description of the customer list. Maximum 2000 characters


Example: List containing users that subscribed from the black friday mailing list.
namestringrequired
Describes the customer list name. Must be unique per workspace. Maximum 100 characters.


Example: black friday list
Response status codes
Arrow
201 - Created
Arrow
Name
Description
colorstring
Describes the customer list color. Must respect the hexcolof format. Default value is '#ffffff' or white.


Example: #6d9382
descriptionstring
The more detailed description of the customer list. Maximum 2000 characters


Example: List containing users that subscribed from the black friday mailing list.
namestringrequired
Describes the customer list name. Must be unique per workspace. Maximum 100 characters.


Example: black friday list
400 - Bad Request
Arrow
Name
Description
codeinteger
Http response status code.


Example: 400
messagestring
The human readable message that describes how to deal with error.


Example: The request body is not valid.
titlestring
The error title.


Example: Bad request.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
500 - Internal Server Error
Arrow
Name
Description
codeinteger
Http response status code.


Example: 500
messagestring
The human readable message that describes how to deal with error.


Example: Internal server error.
titlestring
The error title.


Example: Internal server error.
Request examples
Copied
Arrow
200 Arrow
  • 200
{
    "name": "black friday list",
    "color": "#57f8c8",
    "description": "List of all users who subscribed through the black firday newsletter."
}
Response examples
Copied
Arrow
201 Arrow
  • 201
  • 201
  • 400
  • 500
{
  "id":"1025",
  "company_id":"6197120",
  "name":"black friday list",
  "color":"#57f8c8",
  "description":"List of all users who subscribed through the black firday newsletter."
}

{
  "id": "1000105",
  "company_id": "7196310",
  "name": "black friday list",
  "color": "#6d9382",
  "description": "List containing users that subscribed from the black friday mailing list.",
  "create_time": "2025-01-29 12:47:00",
  "update_time": "2025-01-30 14:27:26"
}

{
  "code": 400,
  "title": "Bad request.",
  "message": "The request body is not valid.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}

{
  "code": 500,
  "title": "Internal server error.",
  "message": "Internal server error."
}