Fleet Management API Beta

Sections

Theme switcher

Update a card record

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

Path Parameters

card-idstring Required

The id for the card

Min length
1

Body Parameters

card_addressobject

Address used in card orders and saved on the card for reuse.

Show child attributes

card_profile_idstring

The card profile id for the card. This will trigger a card reissue.

department_idstring

The department id for the card. Not all accounts use this field.

design_codestring

The design code for the card. This will trigger a card reissue. This field can be used to change the card profile if the card profile id is not known.

driver_prompt_idstring

Use this field in conjunction with the resetPrompt field. Set a new driver prompt id. Only available if your account has a customer prompt value of true and your card usage type supports a driver prompt id.

embossingobject

Show child attributes

ev_requestedboolean

Request electric vehicle charging access. This field is only editable if the card is not currently set up for electric vehicle charging.

partner_identifierstring

An alpha-numeric identifier used by partners to link to their internal systems. Can be 5, 10 or 15 characters depending on account set up.

purchase_control_idstring

The Purchase Control id for the card.

reference_idstring

Reference Id. A Place for customers to add custom data.

reset_prompt_idboolean

Set this value to true if you want to reset the prompt id for this card. If your cards have a customer generated prompt id set the appropriate prompt id for this card with the new value. If you have a system generated prompt id you will only need to set this value to true.

Default value
false
statusobject

Show child attributes

use_address_on_cardboolean

Indicates if the card should be sent to a shipping address that will be stored for reuse.

user_defined_fieldsarray

A list of User Defined Fields.

Max items
20

Show child attributes

Response

200
Object

The card with the new values added.

Response Attributes

_linksobject

HATEOAS links related to the card.

Show child attributes

account_idstring

Account Id.

account_namestring

Name of the account.

batch_order_numberinteger

Batch order number associated with card creation. Use this value to group cards together and order them as a single batch. This value can be set by the user on the card creation request.

card_addressobject

Address used in card orders and saved on the card for reuse.

Show child attributes

card_idstring

Card Id.

card_lockedboolean

Card Locked Flag

card_numberstring

Card Number.

card_profile_idstring

Card Profile Id.

card_profile_namestring

Card Profile Name.

card_suffixinteger

Last digit of the MagStrip number.

card_typestring

Valid Card Types:
Custom Control Fuel Only Fuel and Oil Unrestricted WEX Edge CarAdvise

departmentobject

Department object.

Show child attributes

design_codestring

Design code used determine properties on the card.

driver_idstring

Driver Id.

driver_prompt_idstring

Prompt Id for the driver.

embossed_numberstring

Embossed Number. Used by businesses to store special card numbers.

embossingarray

Used by businesses to store vehicle information or other information that is important to them. The embossing can be customer defined or linked to other attributes on other entities based on the embossing specification defined by the card profile.

Max items
3

Show child attributes

ev_requestedboolean

Request electric vehicle charging access.

ev_requested_datestring

The date electric vehicle charging access was requested. Format: YYYY-MM-DDTHH:MM:SSZ.

expiration_datestring

The date the card expires. Format: YYYY-MM-DDTHH:MM:SSZ

last_issue_datestring

Date card was last issued. Format: YYYY-MM-DDTHH:MM:SSZ.

last_updatedstring

Date card was last changed. Format: YYYY-MM-DDTHH:MM:SSZ.

license_plate_numberstring

License Plate Number.

mag_strip_numberstring

Magnetic Strip Number.

order_idstring

Order Id.

original_card_idstring
partner_identifierstring

An alpha-numeric identifier used by partners to link to their internal systems. Can be 5, 10 or 15 characters depending on account set up.

pos_display_promptstring

Point of Sale prompting for display.

pos_override_promptstring

Point of Sale prompting override.

purchase_control_idstring

Purchase Control Id.

purchase_control_namestring

Purchase Control Name.

reference_idstring

Reference Id. Place for customers to throw goo...

renewal_flagboolean

Indicates if the card is eligible for renewal.

renewal_periodstring

Renewal period.

rfidsarray

List of RFID's associated to the card.

Show child attributes

statusstring

The status of the card.

status_reasonstring

Describes the reason for the card status. A card may be in suspended status because it was reported lost.

usage_typestring

Valid usage types: Asset Driver Driver 1:1 Driver 1:1 Plus Site Usage Vehicle 1:1 Vehicle 1:1 Plus

use_address_on_cardboolean

Indicates if the card should be sent to a shipping address that will be stored for reuse.

user_defined_fieldsarray

User Defined Fields.

Max items
20

Show child attributes

vehicle_customer_idstring

Vehicle Customer Id.

vehicle_descriptionstring

Vehicle Description.

vehicle_idstring

Vehicle Id.

vehicle_prompt_idstring

Prompt Id for the vehicle.

vinstring

Vehicle Identification Number.

400
Object

Invalid request body

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
403
Object

The supplied user does not have access to the associated account(s)

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
404
Object

Invalid Id

Response Attributes

detailed_messagestring
http_statusstring
messagestring
timestampstring
Was this section helpful?

PATCH

/

Select
1

Response

Was this section helpful?