Skip to main content
POST
Send retrieval support message

Authorizations

Authorization
string
header
required

API key authentication. Use format: Authorization: Bearer tavrn_sk_live_...

Path Parameters

retrieval_request_id
string
required

Retrieval request ID

Body

application/json
message
string
required

Support message. Must contain non-whitespace text.

Required string length: 1 - 10000
requester_name
string

Sender's display name.

Maximum string length: 200
requester_email
string<email>

Delivery address. Required when API submissions explicitly select email.

contact_preference
enum<string>

email sends receipts and replies by email. in_app_only logs replies without email; automated replies are currently disabled. do_not_contact processes requested work without customer receipts or replies, except for Litify's initial receipt when requester_email is supplied. If omitted, request_response: false selects do_not_contact; otherwise email.

Available options:
email,
in_app_only,
do_not_contact
request_response
boolean
deprecated

Used when contact_preference is omitted: true (default) means email; false means do_not_contact.

attachment
object

Response

Message recorded

id
string
required

Opaque support conversation ID.

retrieval_request_id
string
required
status
enum<string>
required

Submitted; does not confirm task completion or provider delivery.

Available options:
sent
created_at
string<date-time>

Submission timestamp; omitted for a deduplicated resend.

deduplicated
boolean

True for an identical submission within 10 minutes.