Update Card Information

Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients/{id}/card/information

Method: PUT

📘

This endpoint requires approval prior to access. Please contact your Virtual Incentives Client Success Manager to discuss your use case.

Definitions

FieldTypeDescription
idresponse only
integer
Unique Account Holder ID.
name.first_namestring(50)Account holder first name.

Note: This field is displayed in the email and VRC salutation. For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
name.last_namestring(50)Account holder last name.

Note: For anonymous rewards, please use a generic name such as “Participant” or “Recipient”.
address.address1string(100)Account holder address line 1.
address.address2string(50)Account holder address line 2.
address.citystring(50)Account holder city.
address.statestring(20)Account holder state abbreviation (ISO 3166-2, subdivision).
address.zipstring(10)Account holder zip code.
address.countrystring(2)Account holder country abbreviation (ISO 3166-2).
phone.numberstring(20)Mobile phone number of the recipient. Used for SMS reward delivery. The number must be supplied as digits only.

Note: Required if reward delivery is SMS, or phone country is provided.
phone.countrystring(2)Mobile phone number country of origin. This is the 2-character country code (ISO 3166-2).

Note: Required if reward delivery is SMS, or phone number is provided.

Examples

Request XML

<recipient>
 <address>
    <address1>6 Depot Square</address1>
    <city>Cold Spring</city>
    <state>NY</state>
    <zip>10516</zip>
    <country>US</country>
 </address>
</recipient>

Response XML

<recipient>
 <id>258155</id>
 <name> 
  	<first_name>Reward</first_name>
  	<last_name>Recipient</last_name>
 </name>
 <address>
    <address1>6 Depot Square</address1>
    <address2></address2>
    <city>Cold Spring</city>
    <state>NY</state>
    <zip>10516</zip>
    <country>US</country>
 </address>
 <phone>
    <number>8001234567</number>
    <country>US</country>
 </phone> 
</recipient>

Request JSON

{"recipient":{
	"phone": {
		"number":"8001234567",
		"country":"US"}
    	}
    }

Response JSON

{"recipient":{

"Id":"258155",
"name": {
	"first_name":"Reward",
	"last_name":"Recipient"
 },
 "address": {
	"address1":"6 Depot Square",
  	"address2":"",
	"city":"Cold Spring",
	"state":"NY",
	"Zip":"10516",
	"country":"US
  },
"phone": {
	"number":"8001234567",
	"country":"US"}
	}
}