Endpoint: https://rest.virtualincentives.com/{version}/{format}/recipients?udf1={udf1}

Method: GET

📘
Query string parameters must be URL encoded.

Definitions

Field	Type	Description
id	integer	The unique id for this recipient.
email	string(200)	Account holder email address.
udf1	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf2	string(100)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf3	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf4	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf5	string(1000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf6	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf7	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf8	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf9	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
udf10	string(4000)	Additional User Defined field. Note: See ‘udf1’ for definition.
ordernumber	integer	Order number that this recipient is related to.

Examples

XML Example

<response>
  <page>1</page>
  <more>false</more>
  <count>1</count>
  <total>1</total>

  <recipients>
    <recipient>
      <id>258155</id>
      <email>[email protected]</email>
      <udf1>Sample</udf1>
      <ordernumber>24690878</ordernumber>
    </recipient>
  </recipients>
</response>

JSON Example

{"response":{
"Page":1,
"More":false,
"Count":1,
"Total":1,

"Recipients":[
{"id":"258155",
"email":"[email protected]",
"udf1":"Sample",
"ordernumber":"24690878"}]}}