Skip to main content
POST
Create order message

Authorizations

Authorization
string
header
required

Company-bound Case Management API key — the standard credential for this API.

Headers

X-On-Behalf-Of-Company
string<uuid>

Required when a Partner key calls the Case Management API; rejected for direct Case keys. Contains the entitled paywise company UUID.

Idempotency-Key
string
required

Required client-supplied command key scoped to the selected Case company or Partner owner, method, operation and path. An exact retry replays the original response while it is retained, including after credential rotation or replacement. Current permissions are required.

Maximum string length: 255

Path Parameters

order_id
string<uuid>
required

UUID of the parent order in this request.

Body

application/json

Unknown and read-only request fields are rejected with a validation error instead of being silently ignored.

body
string
required

Message content sent to paywise; supported HTML is sanitized and the content must not be empty after sanitization.

Required string length: 1 - 262144
title
string
required

Short subject of the message.

Required string length: 1 - 200
documents
object[]

Documents attached to the message. At most 20 documents and 50 MiB of decoded document content per command. Each file is limited to 10 MiB and each PDF to 100 pages. Exceeding a limit rejects the command with 400.

Maximum array length: 20

Response

Resource representation with a native UUID id.

author
object
required

Channel through which the message was authored.

body
string | null
required
read-only

Message content exchanged with paywise.

created_at
string<date-time>
required
read-only

Time at which the message was created.

documents
object[]
required
read-only

Documents attached to the message.

editable
boolean
required
read-only

Whether this message can be edited through the API. True only for a client message created through current Case Management API for the calling company while it is under review and no review task has started.

href
string<uri>
required
read-only

API URL of this message.

id
string<uuid>
required
read-only

Stable identifier for this resource.

parent
object
required

Order or accepted case to which the message belongs.

response_to
string<uuid> | null
required
read-only

Message to which this message responds, when applicable.

sender
enum<string>
required

Party that sent the message.

Available options:
client,
paywise
state
enum<string>
required

Review/publication state: under_review for a client message awaiting review, handled after handling, or published for a published message. Check editable before offering edits.

Available options:
under_review,
handled,
published
title
string | null
required
read-only

Short subject of the message.

updated_at
string<date-time>
required
read-only

Time at which the message was last updated.