Reply to an Inbox item
Sends an eligible public reply. Use a stable idempotency key for X responses.
Authorization
AuthorizationBearer <token>In header
Workspace API key kept server-side. Inbox requires the Basic plan or higher.
Idempotency-KeystringIn header
Required for x_reply. Reuse the same key only for the exact same item and text.
Query Params
inbox_scopestring
Required for API-key requests. Use managed_user for one app user or workspace with a creator-bound owner/admin key.
external_user_idOptionalstring
Required only for managed_user. Derive it from the authenticated app user on your server.
Path Params
idstring
Inbound Inbox item ID.
Request Body
textstring
Non-empty public reply text.
Response Body
200
data.idstring
Persisted outbound Inbox item ID.
data.sourcestring
x_reply for an X response.
data.is_ownboolean
true for the sent item.
202
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.
400
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.
403
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.
404
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.
402
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.
409
error.codestring
INBOX_SCOPE_REQUIRED when an API-key request omits inbox_scope.
not_found404
The item does not exist inside the selected scope; cross-scope items are not disclosed.
x_reconnect_required409
Reconnect the account with the required X scopes.
idempotency_key_conflict409
The key was previously used with different text or a different item.
x_write_outcome_pending409
X may have accepted the write. Reuse the key to inspect state; UniPost does not resend it.
x_write_needs_reconciliation409
The outcome needs manual reconciliation; do not create another key to resend.
x_remote_accepted_reconciling202
X accepted the write and UniPost is finishing local persistence.