POST v1/{subscriptionID}/touchPoints/{touchPointID}/process

Processes a touchpoint.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subscriptionID

The Circle subscription ID.

globally unique identifier

Required

touchPointID

The touchpoint ID to be processed.

globally unique identifier

Required

Body Parameters

The production parameters for processing.

ProductionParametersModel
NameDescriptionTypeAdditional information
FilteredListID

Gets and sets the filtered list ID of the production.

globally unique identifier

None.

Range

Gets and sets the production range of recipients.

ProductionRangeModel

None.

Type

Gets the production parameters type.

ProductionParametersType

None.

Request Formats

application/json, text/json, application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns the created run.

RunModel
NameDescriptionTypeAdditional information
ID

Gets the run ID.

globally unique identifier

None.

SubscriptionID

Gets the subscription ID of the run.

globally unique identifier

None.

ProjectID

Gets the project ID of the run.

globally unique identifier

None.

TouchPointID

Gets the touchpoint ID of the run.

globally unique identifier

None.

Creator

Gets the user who created the run.

UserViewModel

None.

CreationTime

Gets the creation time of the run.

date

None.

Type

Gets the run type.

RunType

None.

TriggeringType

Gets the triggering type of the tun.

RunTriggeringType

None.

Status

Gets the run status.

RunStatus

None.

Response Formats

application/json, text/json

Sample:
{
  "ID": "f7ba931d-de2a-46ab-81e7-84257e5f2924",
  "SubscriptionID": "1fcb210e-33d0-41f8-94c1-2bff4c39c419",
  "ProjectID": "b6408922-4c30-4c79-a690-302cda7cac02",
  "TouchPointID": "65029a95-b0e9-4990-8779-cca73fb2fd22",
  "Creator": {
    "ID": "954e0d47-26d8-4cca-bfb3-4866e3f961bd",
    "Name": "sample string 2"
  },
  "CreationTime": "2021-12-02T21:26:48.2427958Z",
  "Type": 1,
  "TriggeringType": 1,
  "Status": 1,
  "ProductionType": 1,
  "Message": "sample string 5",
  "UProduceJobs": [
    {
      "UProduceJobID": "2674447f-482d-4249-a37a-17eb01ee6f0f",
      "FriendlyID": "sample string 2"
    },
    {
      "UProduceJobID": "2674447f-482d-4249-a37a-17eb01ee6f0f",
      "FriendlyID": "sample string 2"
    }
  ]
}