API explorer
Fleet Management API Beta

Sections

Theme switcher

Update an account.

Authentication

Bearer Token

Standard HTTP Bearer token. Enter the 'access_token' value.

TokenstringRequired

Header Parameters

user_idstring

Optional audit field that indicates the User that performed a change. This field cannot be updated directly without appropriate permission - it is automatically set to the clientId of the authenticated User making the request.

Authorizationstring

This API is protected under OAuth 2 with the client_credentials grant flow and requires an API client_id and client_secret.
The client_id and client_secret are provisioned by the Fleet Services team.

Access Tokens have a lifespan of 15 minutes.

Requesting an access token

Parameters:

  • client_id = my-client-id
  • client_secret = my-client-secret
  • [base-url] = Replace with the correct server URL for the environment you are using (e.g. - https://wmd.xc.wexonl...

Path Parameters

account-idstring Required
Min length
1

Body Parameters

account_idstring Required

Id of the Account to update.

account_short_namestring

An abbreviated account name.

Max length
20
customer_account_numberstring

A customer defined number linking a WEX account to the customers account.

default_purchase_control_idstring

Default Purchase Control id.

localestring

The locale used to determine the preferred language for the Account.

Default value
EN_US
Enum values:
EN_USEN_CAFR_CAES_MX
user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

Response

200
Object

The updated account.

Response Attributes

_linksobject

Links to Account related resources

Show child attributes

account_configobject

Account configuration fields

Show child attributes

account_contact_infoobject

Account contact information

Show child attributes

account_idstring

Account Id.

account_namestring

Account Name.

account_numberstring

Account Number.

account_statusobject

Status object for the account

Show child attributes

address_infoobject

Account address information

Show child attributes

billingobject

Account billing info

Show child attributes

card_infoobject

Account card information

Show child attributes

card_shipping_infoobject

Account shipping info for ordered cards

Show child attributes

carrier_infoobject

Account carrier info

Show child attributes

country_codestring

Two letter country abbreviations.

Enum values:
CAMXPRUSUNKNOWN
credit_limitinteger

Credit Limit.

customer_infoobject

Account customer information

Show child attributes

customizationobject

Account customizations

Show child attributes

default_profilestring

Default Profile name.

financially_liable_account_numberstring

Account that is financially liable for the current account.

last_updatedstring

Last update timestamp. Format: YYYY-MM-DDTHH:MM:SSZ.

parent_account_idstring

Account Id for the parent Account.

program_infoobject

Account program info

Show child attributes

prompt_configurationobject

Details about the prompt configuration for the account.

Show child attributes

short_namestring

Account Short Name.

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

400
Object

400 (Bad Request)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
401
Object

401 (Unauthorized)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

403 (Forbidden)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

404 (Not Found)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
500
Object

500 (Internal Server Error)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

PATCH

/

Select
1

Response

Was this section helpful?