Salesforce Docs Portal

PUT /interaction/v1/interactions

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

JSON Parameters

Name Type Description
key string Required. The user-defined Key for the journey to update.
name string Required. The name of the journey.
workflowApiVersion number Required. The Journey Spec version to use for this journey. Possible values: 0.5, 1.0.
version number Required. The version of the journey.
id string The GUID (UUID) to be used while referencing this journey.
modifiedDate string This field must match the Database value. If it doesn’t match, the request is rejected. Your request doesn’t directly update this field, but the value you supply is used in mapping to the correct version of this journey.
description string A description of the journey.
goals array The goal for this particular journey. Expressed as an object of type ContactDecision from the Journey Spec.
triggers array The trigger for this particular journey. Expressed as an object of type ContactEvent from the Journey Spec.
activities array The activities which compose this particular journey. Expressed as objects of types supported by the Journey Spec

Usage

This request updates the journey version specified by the versionNumber Query Parameter.

This example represents the minimum required parameters to update the journey version, as prescribed by the Journey Spec. To understand how to leverage the full capability of updating journeys via the API, the Journey Spec documentation provides a comprehensive list of all available parameters.

These JSON parameters are always provided by Journey Builder and can never be updated:

  • id
  • lastPublishedDate
  • createdDate
  • modifiedDate, used in the request body, but only for mapping
  • definitionId
  • status

Although the modifiedDate may not be updated, you are required to pass current value that matches the database record. This prevents simultaneous writes that would overwrite other users' changes.

Host: https://YOUR_SUBDOMAIN.rest.marketingcloudapis.com
PUT /interaction/v1/interactions/
Content-Type: application/json
Authorization: Bearer YOUR_ACCESS_TOKEN

{
    "key": "ixn-created-via-the-api",
    "modifiedDate": "2014-08-06T08:11:12",
    "name": "API-Created journey updated",
    "version": 2,
    "description": "This is a journey created via the API created in this account",
    "workflowApiVersion": 1.0
}

The response contains metadata about the journey.

HTTP/1.1 200
{
    id: "unique-UUID-provided-by-SFMC"
    key: "ixn-created-via-the-api"
    name: "API-Created journey updated"
    lastPublishedDate: "0001-01-01T00:00:00"
    description: "This is a journey created via the API created in this account"
    version: 2
    workflowApiVersion: 1
    createdDate: "2014-08-06T23:27:08.15"
    modifiedDate: "2014-08-06T23:27:08.15"
    triggers: []
    goals: []
    status: "Draft"
    definitionId: "unique-UUID-provided-by-SFMC"
}

If an error occurs, the response provides an HTTP error code and a description of the error.

HTTP/1.1 304 NO CHANGE
{
    message: "No change has been processed, supplied data matches that on the server."
    errorcode: 304
    documentation: ""
}