Update Segment List

PATCH /segment-lists/{id}
Copied
Arrow
                https://api.ocamba.com/v1/hood/segment-lists/{id}

Updates the specific Segment List. Any parameters not provided will be left unchanged.

path Parameters
Arrow
Name
Description
idstringrequired
Unique resource identifier.


Example: 12345
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.
itemsarray
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
204 - No Content
Arrow
400 - Bad Request
Arrow
500 - Internal Server Error
Arrow

note
1 At least one of the updatable fields should be sent via HTTP body in order to change the current state of the List.
tip
1 If you don't know the id, list the Segments Lists to find it.

Request examples
Copied
Arrow
patch Arrow
  • patch
{
  "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
400 Arrow
  • 400
  • 500
{
  "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"
}