Wex Health and Benefits APIs

Sections

Theme switcher

Release Red Flag

Header Parameters

X-Request-Idstring

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

Idempotency-Keystring Required

Unique idempotency key for this request. Must be a UUID. When the same Idempotency-Key is sent with identical request parameters, the server will return the same result as the original request instead of performing the release again. If the same Idempotency-Key is reused with different parameters, the request may be rejected to prevent conflicting changes.

Query Parameters

person_idstring Required

Unique identifier for the consumer.

Path Parameters

flag_idstring Required

Unique identifier for the red flag to release.

Body Parameters

statusstring Required

The target status for the red flag. Used to support idempotent release actions.

reasonstring Required

A human-readable explanation of why the red flag is being released, used for audit logging and compliance tracking.

Max length
500

Response

200
Object

Successfully released the red flag and associated process holds

Response Attributes

flag_idstring Required

Unique identifier for the flag.

released_bystring

User or system that released the flag.

manual_released_dtstring Required

Date and time when the flag was manually released.

updated_bystring

User or system that last updated the flag record.

updated_dtstring Required

Date and time when the flag record was last updated.

updated_sourceinteger Required

Source system identifier that performed the update.

Minimum
1
Maximum
10
process_holdsarray

List of process holds that were released along with this flag.

Show child attributes

400
Object

Bad Request

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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
titlestring
statusinteger
detailstring
instancestring
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.

403
Object

Forbidden

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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
titlestring
statusinteger
detailstring
instancestring
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

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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.

default
Object

Unexpected error

Response Attributes

typestring
titlestring
statusinteger
detailstring
instancestring
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?

Base URL

Production:

Sandbox:

Language Box

PATCH

/

Select
1

Response

Was this section helpful?