Create a Routing Form - Zeeg Developer Hub

Authorizations

Authorization

string

header

required

Body

application/json

The body that creates a routing form.

name

string

required

The internal name of the routing form. An invitee never reads it.

Maximum string length: 200

Example:

"Inbound Lead Qualification"

headline

string | null

The headline above the questions. It holds rich text of at most 200 visible characters.

Example:

"Tell us about your team"

body

string | null

The body text below the headline. It holds rich text of at most 2000 visible characters.

Example:

"<p>Answer three questions and we send you to the right person.</p>"

submitBtnText

string | null

The label of the submit button.

Maximum string length: 200

Example:

"Continue"

isActive

boolean

default:true

An inactive routing form accepts no submission.

Example:

true

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

styleSettings.bgColor

string | null

Background colour of the page.

Maximum string length: 20

Example:

"#ffffff"

styleSettings.buttonBgColor

string | null

Background colour of the submit button.

Maximum string length: 20

Example:

"#1f2937"

styleSettings.buttonTextColor

string | null

Text colour of the submit button.

Maximum string length: 20

Example:

"#ffffff"

Response

Created

success

boolean

Example:

true

status

integer

Example:

201

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

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.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"]
    }
  ]
}