users

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.<br/> <b>Required scopes:</b> user:update

put/users/users/{id}

Request

  • Base URL: https://rewards-api.getkard.com
  • URL: https://rewards-api.getkard.com/users/users/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Referring partner user ID from issuer that specifies user

Request body

emailstring

Email of user

hashedEmailstring

Hashed email address of user (using SHA-256)

phoneNumberstring

Phone number of user in E.164 format

birthYearstring

Birth year of user

userNamestring

Username of user from issuer

firstNamestring

First name of user

lastNamestring

Last name of user

zipCodestring

Zipcode of user

referringPartnerUserIdstring required

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

externalPartnerUserIdstring

Partner unique user id, might be equal to referringPartnerUserId

enrolledRewardsCommonsEnrolledRewardsType[]

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

Response

Response with status 200

enrolledRewardsCommonsEnrolledRewardsType[]

List of enrolled rewards

emailstring

Email of user if available

hashedEmailstring

Hashed email address of user (using SHA-256)

phoneNumberstring

Phone number of user in E.164 format

birthYearstring

Birth year of user

firstNamestring

First name of user if available

lastNamestring

Last name of user if available

zipCodestring

Zipcode of user if available

referringPartnerUserIdstring required

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

userNamestring

Username of user from issuer if available

Changes

No recorded changes to this operation across all 1 revision of this API.