Skip to content

Update Process List Api

PATCH
/process-lists/{slug}

Rename, describe or archive a list. The parent binding is identity, not a label: it is never accepted here.

Authorizations

Parameters

Path Parameters

slug
required
string

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Rename, describe or archive a list. The parent binding is never accepted here.

object
description
Any of:
string
<= 2000 characters
display_attribute_slug
Any of:
string
>= 1 characters <= 100 characters /^[a-z][a-z0-9_]*$/
icon
Any of:
string
Allowed values: box briefcase building calendar flag folder globe heart layers package target users
is_archived
Any of:
boolean
plural_noun
Any of:
string
>= 1 characters <= 100 characters
singular_noun
Any of:
string
>= 1 characters <= 100 characters

Responses

200

Successful Response

object
data
required
object
api_slug
required
string
created_at
required
string format: date-time
description
Any of:
string
display_attribute_slug
Any of:
string
entries_label
required
string
entry_count
Any of:
integer
icon
Any of:
string
id
required
string format: uuid
is_archived
required
boolean
parent_kind
required
string
Allowed values: custom contacts companies deals
parent_label
required
string
parent_object_id
Any of:
string format: uuid
parent_object_slug
Any of:
string
parent_relationship_definition_id
required
string format: uuid
plural_noun
required
string
singular_noun
required
string
updated_at
required
string format: date-time
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string