Create User

POST
/users/users

Call this endpoint to enroll a specified user into your rewards program. Learn more about the Enrolling Users flow based on your use case here.
Required scopes: user:write

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; AT LEAST one of email or userName is REQUIRED. We HIGHLY RECOMMEND sending both.

userNamestringOptional

Username of user from issuer; AT LEAST one of email or userName is REQUIRED. We HIGHLY RECOMMEND sending both.

firstNamestringOptional

First name of user. We HIGHLY RECOMMEND sending this field.

lastNamestringOptional

Last name of user. We HIGHLY RECOMMEND sending this field.

zipCodestringOptional

Zipcode of user. We HIGHLY RECOMMEND sending this field as it may be required in the near future.

externalPartnerUserIdstringOptional

Partner unique user id, might be equal to referringPartnerUserId

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

If field is not supplied, user will be automatically enrolled in all programs. Note, please do not send AFFILIATE as this field has been deprecated.

cardslist of objectsOptional

List of User Cards Information. This is REQUIRED for matching purposes.

cardInfoobjectOptionalDeprecated

[Deprecated — please use ‘cards’ field] User Card Information

referringPartnerstringOptionalDeprecated

Issuer name

Response

This endpoint returns a string.

Errors

Built with