Update User

PUT
/users/users/:id

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

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 "CARDLINKED" or "AFFILIATE"Optional
Allowed values: CARDLINKEDAFFILIATE

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

Response

This endpoint returns an object.
referringPartnerUserIdstring

Referring partner user ID of user from issuer. Must be a unique identifier across users

enrolledRewardslist of "CARDLINKED" or "AFFILIATE"Optional
Allowed values: CARDLINKEDAFFILIATE

List of enrolled rewards

emailstringOptional

Email of user if available

firstNamestringOptional

First name of user if available

lastNamestringOptional

Last name of user if available

zipCodestringOptional

Zipcode of user if available

cardslist of objectsOptional

List of User Cards Information

userNamestringOptional

Username of user from issuer if available

Errors

Built with