Skip to content

Update Desk List Goal

PUT
/desk/list-goals

Set or clear ONE list’s daily dial target.

Unlike /desk/list-priority this is a single-list edit, and a null target CLEARS the goal rather than setting it to zero - a cleared goal stops the counter, a zero would be a goal that is already met.

Authorizations

Parameters

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Set or clear one list’s daily dial target.

object
audience_id
required

The dial list this target belongs to.

integer
target
Any of:
integer
>= 1 <= 999

Responses

200

Successful Response

object
data
required

An open envelope for one desk object.

Open on purpose - see the module docstring. A rebuilder gets every field the desk returns, including ones added after this contract version.

object
key
additional properties
any
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