Skip to main content
PATCH
/
api
/
v1
/
user_lists
/
{id}
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "tenant": "https://example.com/",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "owner": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "fullName": "<string>",
    "logo": "<string>"
  },
  "criteria": [
    "<string>"
  ],
  "type": "static",
  "scope": "members_and_contacts"
}

Path Parameters

​
id
string
required

UserList identifier

Body

application/merge-patch+json

The updated UserList resource

​
type
enum<string>
default:static
required
Available options:
static,
dynamic
Example:

"static"

​
tenant
string<iri-reference>
Example:

"https://example.com/"

​
name
string
​
owner
string<iri-reference> | null
Example:

"https://example.com/"

​
criteria
string[] | null
​
scope
enum<string> | null
Available options:
members_and_contacts,
members_only,
contacts_only

Response

UserList resource updated

​
type
enum<string>
default:static
required
Available options:
static,
dynamic
Example:

"static"

​
@context
​
@id
string
​
@type
string
​
id
integer
​
tenant
string<iri-reference>
Example:

"https://example.com/"

​
name
string
​
createdAt
string<date-time>
​
owner
object | null
​
criteria
string[] | null
​
scope
enum<string> | null
Available options:
members_and_contacts,
members_only,
contacts_only