Edit a flow's trigger and enrollment policy

curl --request PATCH \
  --url https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "trigger_event_name": "<string>",
  "trigger_segment_id": "<string>",
  "reenroll_cooldown_secs": 123,
  "exit_on_event_names": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    trigger_event_name: '<string>',
    trigger_segment_id: '<string>',
    reenroll_cooldown_secs: 123,
    exit_on_event_names: ['<string>']
  })
};

fetch('https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}"

payload = {
    "name": "<string>",
    "trigger_event_name": "<string>",
    "trigger_segment_id": "<string>",
    "reenroll_cooldown_secs": 123,
    "exit_on_event_names": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"trigger_event_name\": \"<string>\",\n  \"trigger_segment_id\": \"<string>\",\n  \"reenroll_cooldown_secs\": 123,\n  \"exit_on_event_names\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'trigger_event_name' => '<string>',
    'trigger_segment_id' => '<string>',
    'reenroll_cooldown_secs' => 123,
    'exit_on_event_names' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "created_at": "<string>",
    "exit_on_event_names": [
      "<string>"
    ],
    "id": "<string>",
    "live_version_id": "<string>",
    "name": "<string>",
    "reenroll_cooldown_secs": 123,
    "reenrollment": "<string>",
    "status": "<string>",
    "trigger_event_name": "<string>",
    "trigger_segment_id": null,
    "trigger_type": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

PATCH

api

marketing-flows

{marketingFlowId}

Edit a flow's trigger and enrollment policy

curl --request PATCH \
  --url https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '
{
  "name": "<string>",
  "trigger_event_name": "<string>",
  "trigger_segment_id": "<string>",
  "reenroll_cooldown_secs": 123,
  "exit_on_event_names": [
    "<string>"
  ]
}
'

const options = {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: '<string>',
    trigger_event_name: '<string>',
    trigger_segment_id: '<string>',
    reenroll_cooldown_secs: 123,
    exit_on_event_names: ['<string>']
  })
};

fetch('https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}"

payload = {
    "name": "<string>",
    "trigger_event_name": "<string>",
    "trigger_segment_id": "<string>",
    "reenroll_cooldown_secs": 123,
    "exit_on_event_names": ["<string>"]
}
headers = {
    "Idempotency-Key": "<idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"trigger_event_name\": \"<string>\",\n  \"trigger_segment_id\": \"<string>\",\n  \"reenroll_cooldown_secs\": 123,\n  \"exit_on_event_names\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Idempotency-Key", "<idempotency-key>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mercemur.com/api/v1/marketing-flows/{marketingFlowId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'trigger_event_name' => '<string>',
    'trigger_segment_id' => '<string>',
    'reenroll_cooldown_secs' => 123,
    'exit_on_event_names' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "Idempotency-Key: <idempotency-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

{
  "data": {
    "created_at": "<string>",
    "exit_on_event_names": [
      "<string>"
    ],
    "id": "<string>",
    "live_version_id": "<string>",
    "name": "<string>",
    "reenroll_cooldown_secs": 123,
    "reenrollment": "<string>",
    "status": "<string>",
    "trigger_event_name": "<string>",
    "trigger_segment_id": null,
    "trigger_type": "<string>",
    "updated_at": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

{
  "error": {
    "code": "<string>",
    "message": "<string>",
    "resource": "<string>",
    "field": "<string>"
  }
}

Authorizations

Authorization

string

header

required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Headers

Idempotency-Key

string

required

A unique key per logical write. Replaying a request with the same key returns the first response byte for byte instead of applying the write twice.

Path Parameters

marketingFlowId

string

required

Body

application/json

Every field is optional and an omitted one keeps its stored value, which is why this is a PATCH. Sending the whole resource would let an omitted reenrollment reset a weekly program to never, an omitted exit_on_event_names remove every early exit, and an omitted trigger_event_name leave an event trigger that can never fire, all with a 200 and nothing visible until the merchant notices their list stopped receiving mail. EDITING A LIVE FLOW IS ALLOWED and changes only who enters it NEXT. The step graph is untouched, because it lives in an immutable version, and every run in flight keeps walking the version it enrolled on. exit_on_event_names is a WHOLE-LIST REPLACE when present, because a bare string carries no identity to patch an element of. Send [] to clear it; omit the key to leave it alone.

name

string

Still unique per store; a clash is 409 name_taken.

trigger_type

enum<string>

Available options:

event,

segment_entry,

manual

trigger_event_name

string

trigger_segment_id

string

reenrollment

enum<string>

Available options:

never,

after_exit,

after_cooldown

reenroll_cooldown_secs

integer

exit_on_event_names

string[]

Response

Success

data

object

Show child attributes

Overview

Endpoints

Edit a flow's trigger and enrollment policy

Authorizations

Headers

Path Parameters

Body

Response