Skip to content

Get Desk Reply Target

POST
/desk/decisions/{decision_id}/reply-target

Who this card replies TO, and which mailbox it replies FROM.

ALWAYS 200: no address on file, no authorised mailbox and an opt-out all come back as is_sendable: false with a reason.

Resolving is not sending, and this route does neither a write nor a send. Call /desk/decisions/{id}/send-reply for that - it re-runs the opt-out check, because this answer is only as fresh as the moment it was asked.

Authorizations

Parameters

Path Parameters

decision_id
required

Decision id (UUID).

string

Decision id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

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