Create Segment List

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

Creates a new Segment List

Rate limits:

Burst: 10/s
Steady: 150/m

Request Body Schema
Arrow
Name
Description
colorstring
List color. Valid hex color code.


Example: #6d9382
descriptionstring
The more detailed description of the List. string[0 .. 2000]


Example: This is my first segmet list.
itemsarrayrequired
The array of segment ids. array [1 .. 100]


Example: ["1000", "1001"]
namestringrequired
The name of the Segment List. string[2 .. 100] characters.


Example: My List
Response status codes
Arrow
201 - Created
Arrow
Name
Description
colorstring
List color. Valid hex color code.


Example: #6d9382
descriptionstring
The more detailed description of the List. string[0 .. 2000]


Example: This is my first segmet list.
itemsarrayrequired
The array of segment ids. array [1 .. 100]


Example: ["1000", "1001"]
namestringrequired
The name of the Segment List. string[2 .. 100] characters.


Example: My 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
titlestring
The error title.


Example: Internal server error.
trace_idstring
Error trace id.


Example: 99a84211-f73d-4ff8-acdf-eb3e06bb9d62
Request examples
Copied
Arrow
post Arrow
  • post
{
  "id": "1000",
  "company_id": "1000001",
  "name": "My List",
  "color": "#6d9382",
  "size": 10,
  "description": "This is my first segmet list.",
  "items": "[\"1000\", \"1001\"]",
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-30 14:27:26"
}
Response examples
Copied
Arrow
201 Arrow
  • 201
  • 400
  • 500
{
  "id": "1000",
  "company_id": "1000001",
  "name": "My List",
  "color": "#6d9382",
  "size": 10,
  "description": "This is my first segmet list.",
  "items": "[\"1000\", \"1001\"]",
  "create_time": "2021-10-29 12:47:00",
  "update_time": "2021-10-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.",
  "trace_id": "99a84211-f73d-4ff8-acdf-eb3e06bb9d62"
}