POST rest/coupons/{couponId}?batchId={batchId}&sequence={sequence}&recipient={recipient}&recipientType={recipientType}&externalId={externalId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
couponId

globally unique identifier

Required

batchId

string

Required

sequence

integer

Required

recipient

string

None.

recipientType

string

None.

externalId

string

None.

Body Parameters

Collection of Dictionary of string [key] and string [value]

Request Formats

application/json, text/json

Sample:
[
  {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <ArrayOfKeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </KeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 3</Key>
      <Value>sample string 4</Value>
    </KeyValueOfstringstring>
  </ArrayOfKeyValueOfstringstring>
  <ArrayOfKeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </KeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 3</Key>
      <Value>sample string 4</Value>
    </KeyValueOfstringstring>
  </ArrayOfKeyValueOfstringstring>
</ArrayOfArrayOfKeyValueOfstringstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of Dictionary of string [key] and string [value]

Response Formats

application/json, text/json

Sample:
[
  {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  },
  {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
]

application/xml, text/xml

Sample:
<ArrayOfArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <ArrayOfKeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </KeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 3</Key>
      <Value>sample string 4</Value>
    </KeyValueOfstringstring>
  </ArrayOfKeyValueOfstringstring>
  <ArrayOfKeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 1</Key>
      <Value>sample string 2</Value>
    </KeyValueOfstringstring>
    <KeyValueOfstringstring>
      <Key>sample string 3</Key>
      <Value>sample string 4</Value>
    </KeyValueOfstringstring>
  </ArrayOfKeyValueOfstringstring>
</ArrayOfArrayOfKeyValueOfstringstring>