Update a Customer List

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

Updates the specific Customer List by setting the values of the parameters passed. 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
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.
namestring
Describes the customer list name. Must be unique per workspace. Maximum 100 characters.


Example: black friday 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 customer list.
tip
1 If you don't know the customer list id, list the customer lists to find it.

Request examples
Copied
Arrow
200 Arrow
  • 200
{
    "name": "first list",
    "color" : "#af1144",
    "description" : "My first List"
}
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.",
  "message": "Internal server error."
}