Skip to navigation
API referenceCampaigns

Validate and preview a recipient file

Validate and preview a recipient file.

Authentication

AuthorizationBearer

Create and manage workspace-owned keys through the existing app session routes, outside this public API. Creator and manager identities are audit actors only. Key validity follows workspace policy, expiry and explicit revocation, independently of creator membership. Do not include a workspace-selection header.

Request

This endpoint expects a multipart form containing a file.
recipientsfileRequired
recipient_editsstring or nullOptional<=1048576 characters

Response headers

X-Request-IdstringOptional
Safe server request correlation ID.
RateLimit-LimitintegerOptional
Requests allowed in the current window for the tightest applicable limit.
RateLimit-RemainingintegerOptional
Requests left in the current window.
RateLimit-ResetintegerOptional
Seconds until the current window resets.

Response

Validate and preview a recipient file.
refusalmap from strings to any or null
headerslist of strings
submittedinteger>=0
acceptedinteger>=0
invalidinteger>=0
duplicateinteger>=0
suppressedinteger>=0
removedinteger>=0
rowslist of maps from strings to any

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
413
Content Too Large Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error