POST /interaction/v1/interactions/pause/{definitionID}?versionNumber={versionNumber}

Overview

Pauses the running journey that matches the specified definitionID.

URL Parameters

NameTypeDescription
definitionIDstringRequiredThe ID of the journey to be paused, expressed in the form of a GUID (UUID).
versionNumberintegerRequiredThe version number of the journey to be paused. This parameter is optional only when the allVersions parameter is true.
allVersionsintegerIndicates whether to pause all versions of the journey. This parameter is required only when you don't provide a versionNumber in the request URL.

JSON Parameters

NameTypeDescription
ExtendWaitEndDatesbooleanIndicates whether to extend waits for all Wait by Duration activities while the journey is paused. This parameter applies only to Wait By Duration wait types. If the value is true, the wait end date is extended by the pause period. If the value is false, the wait end date isn't extended. If you don't use this parameter, the default value is false.
PausedDaysintegerNumber of days to pause the journey. Default is 14 days.
GuardrailActionstringIndicates whether to resume or stop the journey after the pause duration (PausedDays). Allowed values are Stop and Resume. If you don't use this parameter, the default value is false.
RetainContactInjectionWhileJourneyPausedbooleanIndicates how new contact injections are treated (for entry sources that support this option) while the journey is paused. Choose whether to ignore new contacts (false) or to queue and process them when the journey resumes (true). If you don't use this parameter, the default value is false.
idstringID of the journey to be paused.
VersionstringVersion of the journey to be paused.

Usage

Example Request

Response: No Errors

Response: Missing Version Number

Response: Invalid Id

Response: No Journey That Can Be Paused Matches the Id

Response: Runtime Error

Response: Empty or Incorrect Authorization Token