Wex Health and Benefits APIs

Sections

Theme switcher

Get Message

Header Parameters

X-Request-Idstring

Optional correlation ID associated with the request, comprised of alphanumeric or hyphen characters up to 36 characters in length.

Empty value:
True
Authorizationstring

Path Parameters

message_idstring Required

Response

200
Object

OK

Response Attributes

message_idstring

The unique identifier for the message.

subjectstring | null

The subject line or title of the message.

contentstring | null

The body content of the message.

created_datestring

The timestamp when the message was created.

readboolean

Indicates whether the message has been marked as read by the receiver.

Default value
false
acknowledged_datestring | null

The timestamp when the message was acknowledged by the receiver, if applicable.

archivedboolean

Indicates whether the message has been archived.

Default value
false
favoriteboolean

Indicates whether the message is marked as a favorite

Default value
false
senderstring | null

The identifier or name of the message sender.

receiverstring | null

The identifier or name of the message receiver.

documentsarray | null

A list of Document objects attached to this message. Each document includes a document_id that can be used with the corresponding reporting or document service to download the file contents.

Show child attributes

400
Object

Bad Request

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

401
Object

Unauthorized

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

404
Object

Not Found

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

500
Object

Internal Server Error

default
Object

Unexpected error

Response Attributes

typestring | null
titlestring | null
statusinteger | null
detailstring | null
instancestring | null
invalid_paramsarray | null

List of invalid parameters that caused the validation error.

Max items
10

Show child attributes

errorsobject

Human-readable validation error messages keyed by field name. Each key maps to one or more error message strings.

validation_errorsobject

Field-level validation errors keyed by field name. Each key maps to one or more structured error details.

Was this section helpful?

GET

/

Select
1

Response

Was this section helpful?