POST /interaction/v1/interactions/stop/{definitionId}?versionNumber={versionNumber}

Overview

Stops a running journey. To call this resource, assign your API Integration the Automation | Interactions | Read scope.

URL Parameters

NameTypeDescription
idstringRequiredThe ID of the journey to stop, expressed in the form of a GUID (UUID).
versionNumberintegerRequiredThe version number of the journey to stop

Usage

Example Request

This request stops the journey specified by the ID request parameter. Only the versionNumber specified in the versionNumber QUERY Parameter is stopped. A complete request requires you to provide a valid versionNumber.

Response: No Errors

Response: Server Error

Response: Missing Version Number

Response: Invalid Id

Response: Runtime Error

Response: Empty or Incorrect Authorization Token

Response: Id Not Corresponding to a Journey That Can Be Stopped