Campaigns

Create campaign reply flow

Creates an immutable reply flow revision: the steps a campaign runs when a recipient replies. Each step can send a text, reply buttons, a list, or a Flow form (Official numbers only), and branches on the button or list row chosen, an exact keyword, or a Flow form submission. Beta: returns 403 unless campaign reply flows are enabled for the team. 409 means this flow key and revision already exist.

Requires campaigns:manage. Project tokens only access resources in their own project.

POST

platform

campaign-reply-flows

Create campaign reply flow

curl --request POST \
  --url https://api.polymorfa.com/platform/campaign-reply-flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": {
    "entryNodeId": "<string>",
    "nodes": [
      {
        "id": "<string>",
        "edges": [
          {
            "match": {},
            "to": "<string>"
          }
        ]
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    definition: {
      entryNodeId: '<string>',
      nodes: [{id: '<string>', edges: [{match: {}, to: '<string>'}]}]
    }
  })
};

fetch('https://api.polymorfa.com/platform/campaign-reply-flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/campaign-reply-flows"

payload = {
    "name": "<string>",
    "definition": {
        "entryNodeId": "<string>",
        "nodes": [
            {
                "id": "<string>",
                "edges": [
                    {
                        "match": {},
                        "to": "<string>"
                    }
                ]
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaign-reply-flows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"entryNodeId\": \"<string>\",\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"edges\": [\n          {\n            \"match\": {},\n            \"to\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  }\n}")

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

	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))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flowKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revision": 123,
    "name": "<string>",
    "definition": {
      "entryNodeId": "<string>",
      "nodes": [
        {
          "id": "<string>",
          "edges": [
            {
              "match": {
                "kind": "choice"
              },
              "to": "<string>"
            }
          ],
          "send": {
            "kind": "text"
          }
        }
      ]
    },
    "createdAt": 123
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Authorizations

Authorization

string

header

required

Send your team API key or project token as Authorization: Bearer <token>. The credential must have the required permissions. Project tokens can access only their own project.

Body

application/json

name

string

required

Human-readable name for this resource.

Value constraints

Constraint	Accepted input
String length	`1` through `128` characters

Required string length: 1 - 128

definition

object

required

Structured definition for this resource.

Show child attributes

flowKey

string<uuid>

Existing flow key to add a revision to. Omit to start a new reply flow.

Value constraints

Constraint	Accepted input
Format	`uuid`

revision

integer

Defaults to 1; each key and revision can be created once.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `1000000` (inclusive)

Required range: 1 <= x <= 1000000

projectId

string<uuid>

Required when using a team API key. Project tokens derive the project from the credential.

Value constraints

Constraint	Accepted input
Format	`uuid`

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

Create campaign reply flow

curl --request POST \
  --url https://api.polymorfa.com/platform/campaign-reply-flows \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "definition": {
    "entryNodeId": "<string>",
    "nodes": [
      {
        "id": "<string>",
        "edges": [
          {
            "match": {},
            "to": "<string>"
          }
        ]
      }
    ]
  }
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    definition: {
      entryNodeId: '<string>',
      nodes: [{id: '<string>', edges: [{match: {}, to: '<string>'}]}]
    }
  })
};

fetch('https://api.polymorfa.com/platform/campaign-reply-flows', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/campaign-reply-flows"

payload = {
    "name": "<string>",
    "definition": {
        "entryNodeId": "<string>",
        "nodes": [
            {
                "id": "<string>",
                "edges": [
                    {
                        "match": {},
                        "to": "<string>"
                    }
                ]
            }
        ]
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

package main

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

func main() {

	url := "https://api.polymorfa.com/platform/campaign-reply-flows"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"definition\": {\n    \"entryNodeId\": \"<string>\",\n    \"nodes\": [\n      {\n        \"id\": \"<string>\",\n        \"edges\": [\n          {\n            \"match\": {},\n            \"to\": \"<string>\"\n          }\n        ]\n      }\n    ]\n  }\n}")

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

	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))

}

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "flowKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "revision": 123,
    "name": "<string>",
    "definition": {
      "entryNodeId": "<string>",
      "nodes": [
        {
          "id": "<string>",
          "edges": [
            {
              "match": {
                "kind": "choice"
              },
              "to": "<string>"
            }
          ],
          "send": {
            "kind": "text"
          }
        }
      ]
    },
    "createdAt": 123
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "request_id": "<string>",
    "request_log_url": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Create campaign reply flow

Authorizations

Body

Response