API ReferenceUsers

Update User

Call this endpoint to update the details on a specified user. If you would like to add a card to a specified user, please refer to the Create User Card endpoint.
Required scopes: user:update

Path parameters

idstringRequired
Referring partner user ID from issuer that specifies user

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
referringPartnerUserIdstringRequired
Referring partner user ID of user from issuer. Must be a unique identifier across users
emailstringOptional
Email of user
userNamestringOptional
Username of user from issuer
firstNamestringOptional
First name of user
lastNamestringOptional
Last name of user
zipCodestringOptional
Zipcode of user
externalPartnerUserIdstringOptional
Partner unique user id, might be equal to referringPartnerUserId
enrolledRewardslist of enumsOptional

An empty array will unenroll user from all programs. Note, please do not send AFFILIATE as this field has been deprecated.

Allowed values:

Response

This endpoint returns an object.
referringPartnerUserIdstring
Referring partner user ID of user from issuer. Must be a unique identifier across users
enrolledRewardslist of enums or null
List of enrolled rewards
Allowed values:
emailstring or null
Email of user if available
firstNamestring or null
First name of user if available
lastNamestring or null
Last name of user if available
zipCodestring or null
Zipcode of user if available
cardslist of objects or null
List of User Cards Information
userNamestring or null
Username of user from issuer if available

Errors