POST v1/{subscriptionID}/touchPoints/{touchPointID}/preview/byRecipientIndex?recipientIndex={recipientIndex}&ignoreCache={ignoreCache}
Previews a touchpoint by a recipient index.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| subscriptionID |
The Circle subscription ID. |
globally unique identifier |
Required |
| touchPointID |
The touchpoint ID to be previewed. |
globally unique identifier |
Required |
| recipientIndex |
The index of the recipient to be previewed. |
integer |
Required |
| ignoreCache |
The value is 'true' if the preview result should be regenerated even though a previous result is stored in the cache, and 'false' otherwise. |
boolean |
Optional. Default value is False |
Body Parameters
None.
Response Information
Resource Description
Returns the created preview result.
PreviewResultModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Type |
Gets the touchpoint type. |
TouchPointType |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.