Replace Routing Form Routes - Zeeg Developer Hub

PUT

routing-forms

{id}

routes

curl --request PUT \
  --url https://api.zeeg.me/v2/routing-forms/{id}/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "routes": [
    {
      "type": "EVENT_TYPE",
      "eventTypeId": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "rules": {
        "all": [
          {
            "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
            "operator": "is_any_of",
            "values": [
              "50-200 employees"
            ]
          }
        ]
      }
    }
  ]
}
'

{
  "success": true,
  "status": 200,
  "routingForm": {
    "id": "f1cbafc4-b646-4cf9-af29-193491b555d9",
    "name": "Inbound Lead Qualification",
    "slug": "inbound-lead-qual",
    "url": "https://zeeg.me/RF/inbound-lead-qual",
    "isActive": true,
    "headline": "Tell us about your team",
    "body": null,
    "submitBtnText": "Continue",
    "styleSettings": {
      "bgColor": "#ffffff",
      "buttonBgColor": "#1f2937",
      "buttonTextColor": "#ffffff"
    },
    "createdAt": "2026-04-01T09:12:44+00:00",
    "updatedAt": "2026-04-11T11:31:07+00:00",
    "inputs": [],
    "routes": [
      {
        "id": "c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84",
        "type": "EVENT_TYPE",
        "isFallback": false,
        "order": 0,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": null,
        "body": null,
        "eventType": {
          "id": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
          "title": "30-Minute Discovery Call",
          "slug": "30min-discovery-call",
          "uri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"
        },
        "team": null,
        "rules": {
          "all": [
            {
              "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
              "operator": "is_any_of",
              "values": [
                "50-200 employees"
              ]
            }
          ]
        }
      },
      {
        "id": "2e7f4b90-8a13-4c6d-b5e2-7f0a9c3d1e64",
        "type": "CUSTOM_PAGE",
        "isFallback": true,
        "order": 1,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": "Thank you",
        "body": "A member of the team contacts you within one working day.",
        "eventType": null,
        "team": null,
        "rules": []
      }
    ]
  }
}

Alpha This endpoint is in alpha: the request shape may still change without a deprecation cycle. Replaces the routes of one routing form and returns the routing form in the shape that Get a Routing Form returns.

The write covers the whole list

routes holds the complete route list. This endpoint is not an append and not a patch.

Every entry creates a route. An id in an entry is ignored, and the response carries the new ids.
A stored route that the body leaves out is deleted.

Read the routes first and send them back with your changes. Send the whole list every time. routes must be present. A body without it answers 422, so a mistyped key never deletes every route. Array position sets the route order. The routing form reads the routes in that order and takes the first route whose conditions hold.

The fallback

fallback is optional. It is the destination that takes every submission that matches no route. If the body names no fallback, the routing form keeps its stored fallback destination. Replacing the route list never moves where an unmatched submission goes.

The fallback decides where every unmatched submission goes. A body that restates it slightly differently redirects that traffic, and nothing in the response says so. Leave fallback out unless you mean to change it.

The rule tree

A route carries rules, the condition tree that selects it. A group holds child nodes under all for AND, or under any for OR. A child is a group or a condition.

{
  "all": [
    {
      "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
      "operator": "is_any_of",
      "values": ["50-200 employees"]
    }
  ]
}

A condition names its question with inputId, the same key that the read endpoints return. The operator is one of equals, does_not_equal, is_any_of, is_not_any_of, contains, does_not_contain, starts_with, ends_with, greater_than, greater_than_or_equal, less_than, less_than_or_equal, is_empty or is_not_empty. equals and does_not_equal take exactly one value. The list operators take 1 to 500 values. The ordering operators take exactly one numeric value and match only a numeric answer. is_empty and is_not_empty take none.

Destinations

type takes EVENT_TYPE, TEAM_PAGE, URL or CUSTOM_PAGE. Each type reads its own fields: eventTypeId, teamId, customUrl with submissionParamsForwarding, or headline with body.

A route points at an event type or a team of your own organization. A route that points anywhere else answers 400, and the whole write is refused. A rule that names a question of another routing form answers 400 as well.

The id is a UUID. A malformed id answers 404, not 422. A routing form outside your workspace answers 404 as well.

Authorizations

Authorization

string

header

required

Path Parameters

string<uuid>

required

UUID of the routing form.

Body

application/json

The body that replaces the routes of a routing form.

routes

object[]

required

The complete route list. Array position sets the route order, and the routing form takes the first route whose conditions hold.

Hide child attributes

routes.type

enum<string>

required

The kind of destination. EVENT_TYPE opens a scheduling page, TEAM_PAGE opens the page of a team, URL redirects to an external address, and CUSTOM_PAGE shows a message inside the routing form.

Available options:

EVENT_TYPE,

URL,

CUSTOM_PAGE,

TEAM_PAGE

Example:

"EVENT_TYPE"

routes.rules

object

required

A node of the condition tree that selects a route. A group holds child nodes under all for AND, or under any for OR. A child is a group or a condition. The tree nests at most 10 levels deep.

Hide child attributes

routes.rules.all

object[]

Every child node must hold.

One condition of a rule tree. It names a question of the same routing form with inputId.

Hide child attributes

routes.rules.all.inputId

string<uuid>

required

Id of the question that the condition reads. The question belongs to the same routing form.

Example:

"f7c82298-6dd9-43bd-98e4-c437b5c0ae47"

routes.rules.all.operator

enum<string>

required

The comparison. equals and does_not_equal take exactly one value. The list operators take 1 to 500 values. The ordering operators greater_than, greater_than_or_equal, less_than and less_than_or_equal take exactly one numeric value and match only a numeric answer. is_empty and is_not_empty take none.

Available options:

equals,

does_not_equal,

is_any_of,

is_not_any_of,

contains,

does_not_contain,

starts_with,

ends_with,

greater_than,

greater_than_or_equal,

less_than,

less_than_or_equal,

is_empty,

is_not_empty

Example:

"is_any_of"

routes.rules.all.values

(string | integer)[]

The values that the operator compares the answer against. Each value is a non-empty string or an integer.

Example:

["50-200 employees"]

routes.rules.any

object[]

One child node must hold.

One condition of a rule tree. It names a question of the same routing form with inputId.

Hide child attributes

routes.rules.any.inputId

string<uuid>

required

Id of the question that the condition reads. The question belongs to the same routing form.

Example:

"f7c82298-6dd9-43bd-98e4-c437b5c0ae47"

routes.rules.any.operator

enum<string>

required

Available options:

equals,

does_not_equal,

is_any_of,

is_not_any_of,

contains,

does_not_contain,

starts_with,

ends_with,

greater_than,

greater_than_or_equal,

less_than,

less_than_or_equal,

is_empty,

is_not_empty

Example:

"is_any_of"

routes.rules.any.values

(string | integer)[]

The values that the operator compares the answer against. Each value is a non-empty string or an integer.

Example:

["50-200 employees"]

Example:

{
  "all": [
    {
      "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
      "operator": "is_any_of",
      "values": ["50-200 employees"]
    }
  ]
}

routes.id

string<uuid>

Ignored on write: every entry creates a route, and the read endpoint returns the new ids.

Example:

"c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84"

routes.eventTypeId

string<uuid>

Id of the event type that an EVENT_TYPE route opens. The event type must sit in your own organization.

Maximum string length: 40

Example:

"80f46bf5-eb01-4c07-960e-a9a3e18aae5e"

routes.teamId

string<uuid>

Id of the team that a TEAM_PAGE route opens. The team must sit in your own organization.

Maximum string length: 40

Example:

"3d9b1a77-2c58-4e6a-9f30-8b1c5d4e2f6a"

routes.customUrl

string

Destination address of a URL route.

Maximum string length: 500

Example:

"https://example.com/enterprise"

routes.submissionParamsForwarding

boolean

Set it to true to append the answers to the destination as query parameters. An absent flag stores false, so send back the value the read endpoint returns.

Example:

true

routes.headline

string

Headline of a CUSTOM_PAGE route. It holds rich text of at most 200 visible characters.

Example:

"Thank you"

routes.body

string | null

Body text of a CUSTOM_PAGE route. It holds rich text of at most 2000 visible characters.

Example:

"A member of the team contacts you within one working day."

fallback

object

The fallback destination of a routing form. It takes every submission that matches no route, so it carries no rules.

Hide child attributes

fallback.type

enum<string>

required

The kind of destination.

Available options:

EVENT_TYPE,

URL,

CUSTOM_PAGE,

TEAM_PAGE

Example:

"CUSTOM_PAGE"

fallback.eventTypeId

string<uuid>

Id of the event type that an EVENT_TYPE fallback opens. The event type must sit in your own organization.

Maximum string length: 40

Example:

null

fallback.teamId

string<uuid>

Id of the team that a TEAM_PAGE fallback opens. The team must sit in your own organization.

Maximum string length: 40

Example:

null

fallback.customUrl

string<uri>

Destination address of a URL fallback. It must be a valid URL.

Example:

null

fallback.submissionParamsForwarding

boolean

Set it to true to append the answers to a URL destination as query parameters.

Example:

false

fallback.headline

string

Headline of a CUSTOM_PAGE fallback. It holds rich text of at most 200 visible characters.

Example:

"Thank you"

fallback.body

string | null

Body text of a CUSTOM_PAGE fallback. It holds rich text of at most 2000 visible characters.

Example:

"A member of the team contacts you within one working day."

Response

success

boolean

Example:

true

status

integer

Example:

200

routingForm

object

A routing form with its questions and its routes, as returned when you fetch one routing form.

Hide child attributes

routingForm.id

string<uuid>

Example:

"f1cbafc4-b646-4cf9-af29-193491b555d9"

routingForm.name

string

The internal name of the routing form.

Example:

"Inbound Lead Qualification"

routingForm.slug

string

The slug that addresses the routing form in its public URL.

Example:

"inbound-lead-qual"

routingForm.url

string<uri>

The public address at which an invitee opens the routing form.

Example:

"https://zeeg.me/RF/inbound-lead-qual"

routingForm.isActive

boolean

An inactive routing form accepts no submission.

Example:

true

routingForm.headline

string | null

The headline that the routing form shows above the questions.

Example:

"Tell us about your team"

routingForm.body

string | null

The body text that the routing form shows below the headline.

Example:

null

routingForm.submitBtnText

string | null

The label on the submit button of the routing form.

Example:

"Continue"

routingForm.styleSettings

object

The colours of the public routing form page. Each value is a CSS colour of at most 20 characters, or null when the routing form sets no colour. A response always carries the object with all three keys. The write endpoints accept the same shape, so a routing form that you read goes straight back to PATCH /routing-forms/{id} without reshaping.

Hide child attributes

routingForm.styleSettings.bgColor

string | null

Background colour of the page.

Maximum string length: 20

Example:

"#ffffff"

routingForm.styleSettings.buttonBgColor

string | null

Background colour of the submit button.

Maximum string length: 20

Example:

"#1f2937"

routingForm.styleSettings.buttonTextColor

string | null

Text colour of the submit button.

Maximum string length: 20

Example:

"#ffffff"

routingForm.createdAt

string<date-time> | null

Time at which the routing form was created, in UTC.

Example:

"2026-04-01T09:12:44+00:00"

routingForm.updatedAt

string<date-time> | null

Time of the last change to the routing form, in UTC.

Example:

"2026-04-10T08:30:00+00:00"

routingForm.inputs

object[]

The questions of the routing form, which the invitee answers in the given order.

Hide child attributes

routingForm.inputs.id

string<uuid>

Example:

"f7c82298-6dd9-43bd-98e4-c437b5c0ae47"

routingForm.inputs.label

string

The question text that the invitee reads.

Example:

"What is your company size?"

routingForm.inputs.type

enum<string>

The answer control that the routing form shows for this question.

Available options:

TEXT_INPUT,

TEXTAREA,

SELECT,

RADIO_INPUT,

EMAIL,

PHONE_NUMBER,

NUMBER_INPUT,

CRM_ATTRIBUTE

Example:

"SELECT"

routingForm.inputs.order

integer

Position of the question in the routing form. The first question carries 0.

Example:

0

routingForm.inputs.isRequired

boolean

True when the invitee must answer the question.

Example:

true

routingForm.inputs.isActive

boolean

The routing form hides the question when this is false.

Example:

true

routingForm.inputs.options

(string | object)[]

The selectable values of the question. A SELECT or RADIO_INPUT question carries plain strings. A CRM_ATTRIBUTE question carries the option objects of the CRM attribute. Every other type carries an empty array.

Example:

["1-10 employees", "50-200 employees"]

routingForm.inputs.crmAttribute

object | null

The CRM attribute that a question maps onto. It is null when the question maps onto no attribute.

Hide child attributes

routingForm.inputs.crmAttribute.objectSlug

string

Slug of the CRM object that holds the attribute.

Example:

"companies"

routingForm.inputs.crmAttribute.attributeSlug

string

Slug of the attribute on that object.

Example:

"industries"

routingForm.routes

object[]

The routes of the routing form. Exactly one route is the fallback.

Hide child attributes

routingForm.routes.id

string<uuid>

Example:

"c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84"

routingForm.routes.type

enum<string>

The kind of destination. EVENT_TYPE opens a scheduling page, TEAM_PAGE opens the page of a team, URL redirects to an external address, and CUSTOM_PAGE shows a message inside the routing form.

Available options:

EVENT_TYPE,

URL,

CUSTOM_PAGE,

TEAM_PAGE

Example:

"EVENT_TYPE"

routingForm.routes.isFallback

boolean

The fallback route takes every submission that matches no other route.

Example:

false

routingForm.routes.order

integer

Position of the route in the routing form. The first route carries 0. The routing form takes the first route whose conditions hold.

Example:

0

routingForm.routes.customUrl

string | null

Destination address of a URL route. It is null for every other type.

Example:

null

routingForm.routes.submissionParamsForwarding

boolean

True when the answers are appended to the destination as query parameters. Send it back unchanged when you replace the routes, since an absent flag stores false.

Example:

false

routingForm.routes.headline

string | null

Headline of a CUSTOM_PAGE route.

Example:

"Thank you"

routingForm.routes.body

string | null

Body text of a CUSTOM_PAGE route.

Example:

"A member of the team contacts you within one working day."

routingForm.routes.eventType

object | null

The event type that a route or a submission points at. It is null when no event type is set.

Hide child attributes

routingForm.routes.eventType.id

string<uuid>

Example:

"80f46bf5-eb01-4c07-960e-a9a3e18aae5e"

routingForm.routes.eventType.title

string

Example:

"30-Minute Discovery Call"

routingForm.routes.eventType.slug

string

Example:

"30min-discovery-call"

routingForm.routes.eventType.uri

string<uri>

Address of the event type in this API.

Example:

"https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"

routingForm.routes.team

object | null

The team that a route or a submission points at. It is null when no team is set.

Hide child attributes

routingForm.routes.team.id

string<uuid>

Example:

"3d9b1a77-2c58-4e6a-9f30-8b1c5d4e2f6a"

routingForm.routes.team.title

string

Example:

"Sales EMEA"

routingForm.routes.team.slug

string

Example:

"sales-emea"

routingForm.routes.rules

The condition tree that selects this route. A node is either a group or a condition. A group holds child nodes under any for OR, or under all for AND. A condition holds inputId, operator and values. The operator is one of equals, does_not_equal, is_any_of, is_not_any_of, contains, does_not_contain, starts_with, ends_with, greater_than, greater_than_or_equal, less_than, less_than_or_equal, is_empty or is_not_empty. The fallback route carries an empty array, because it needs no condition.

Example:

{
  "all": [
    {
      "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
      "operator": "is_any_of",
      "values": ["50-200 employees"]
    }
  ]
}

Last modified on November 1, 2026

curl --request PUT \
  --url https://api.zeeg.me/v2/routing-forms/{id}/routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "routes": [
    {
      "type": "EVENT_TYPE",
      "eventTypeId": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
      "rules": {
        "all": [
          {
            "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
            "operator": "is_any_of",
            "values": [
              "50-200 employees"
            ]
          }
        ]
      }
    }
  ]
}
'

{
  "success": true,
  "status": 200,
  "routingForm": {
    "id": "f1cbafc4-b646-4cf9-af29-193491b555d9",
    "name": "Inbound Lead Qualification",
    "slug": "inbound-lead-qual",
    "url": "https://zeeg.me/RF/inbound-lead-qual",
    "isActive": true,
    "headline": "Tell us about your team",
    "body": null,
    "submitBtnText": "Continue",
    "styleSettings": {
      "bgColor": "#ffffff",
      "buttonBgColor": "#1f2937",
      "buttonTextColor": "#ffffff"
    },
    "createdAt": "2026-04-01T09:12:44+00:00",
    "updatedAt": "2026-04-11T11:31:07+00:00",
    "inputs": [],
    "routes": [
      {
        "id": "c4a1e0d2-5f39-4a7b-8f11-2b6d0c9e7a84",
        "type": "EVENT_TYPE",
        "isFallback": false,
        "order": 0,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": null,
        "body": null,
        "eventType": {
          "id": "80f46bf5-eb01-4c07-960e-a9a3e18aae5e",
          "title": "30-Minute Discovery Call",
          "slug": "30min-discovery-call",
          "uri": "https://api.zeeg.me/v2/event-types/80f46bf5-eb01-4c07-960e-a9a3e18aae5e"
        },
        "team": null,
        "rules": {
          "all": [
            {
              "inputId": "f7c82298-6dd9-43bd-98e4-c437b5c0ae47",
              "operator": "is_any_of",
              "values": [
                "50-200 employees"
              ]
            }
          ]
        }
      },
      {
        "id": "2e7f4b90-8a13-4c6d-b5e2-7f0a9c3d1e64",
        "type": "CUSTOM_PAGE",
        "isFallback": true,
        "order": 1,
        "customUrl": null,
        "submissionParamsForwarding": false,
        "headline": "Thank you",
        "body": "A member of the team contacts you within one working day.",
        "eventType": null,
        "team": null,
        "rules": []
      }
    ]
  }
}

​The write covers the whole list

​The fallback

​The rule tree

​Destinations

Authorizations

Path Parameters

Body

Response

The write covers the whole list

The fallback

The rule tree

Destinations