---
title: "Workflow Steps API Reference | Linkbreakers"
description: "What happens when someone opens a link: the steps (redirects, forms, pages, conditions, a chat bot) and where each step's exits lead."
canonical: "https://linkbreakers.com/help/api/workflow-steps"
---

# Workflow Steps

What happens when someone opens a link: the steps (redirects, forms, pages, conditions, a chat bot) and where each step's exits lead.

13 entries on this page

## The workflow step object

One step of a link's workflow, the path a visitor follows after a scan. Defines what happens (a redirect, a gate, a form...) and which steps it connects to.

`attributeCapture` object

What this step saves to the visitor's profile when a visitor goes through it. Absent when the step has never been configured to save anything.

2 child attributes

`enabled` boolean

Off keeps the configured writes without running them.

`writes` array of object

Up to 20 values to save. Each runs when the visitor goes through the step.

4 child attributes

`key` string

The attribute key, such as "looking\_for" or "book\_a\_viewing\_at". Letters, digits, "\_", "-" and "."; keys starting with "$" are reserved.

`mode` enum

SET (default) keeps the latest value; SET\_ONCE keeps the first.

Allowed values

* `ATTRIBUTE_WRITE_MODE_SET` Overwrite, so the profile holds the latest value.
* `ATTRIBUTE_WRITE_MODE_SET_ONCE` Keep the first value, for first-touch facts.

`type` enum

How the value is stored, so it can be compared and filtered. Defaults to STRING. Use DATE with {{now}} for milestones and ENUM for choices.

Allowed values

* `VISITOR_ATTRIBUTE_TYPE_STRING`
* `VISITOR_ATTRIBUTE_TYPE_NUMBER`
* `VISITOR_ATTRIBUTE_TYPE_BOOLEAN`
* `VISITOR_ATTRIBUTE_TYPE_DATE`
* `VISITOR_ATTRIBUTE_TYPE_ENUM`

`value` string

Literal text, or a template filled in when the visitor goes through the step: {{now}}, {{link.name}}, {{link.metadata.<key>}}, and on MULTI\_LINK steps {{choice.label}} and {{choice.id}} for the button tapped. A write whose value comes out empty is skipped.

`backButton` object

The page's optional back button, which returns the visitor to the page they came from (such as the menu) without wiring a connection. Absent when it has never been configured. Only page steps carry one.

2 child attributes

`enabled` boolean

Shows the button. Off keeps the label for when it is switched back on.

`label` string

Text on the button, up to 40 characters. Defaults to "Back".

`backButtonAvailable` boolean 

Read-only

Whether this step's backButton can ever show: the step is a page and some visitor reaches it after already seeing another page (a menu, a form, a password page). False on a page that comes straight after the scan, even through conditions, because a visitor there has no page to go back to. A backButton stored on a step where this is false is kept, so it shows again once the wiring puts a page before the step.

`branches` array of object 

Read-only

Every exit of this step, with its current destination.

This is the vocabulary for connecting the step: pass one of these branch\_ids when connecting a step exit. An atomic step has exactly one branch, "next". A composite step has one per button, option or range, plus "else" for a condition's fallback. An exit step has none.

3 child attributes

`branchId` string

The id this branch is addressed by: "next" for an atomic step's single exit, "else" for a condition's fallback, or the id the branch carries in the step's payload — a button id, option id, range id, or country code.

`label` string

Human-readable name of the branch: a button's label, a country code, a condition option's name, "fallback", "next step".

`nextStepId` string

The step this branch leads to. Empty when the branch is unconnected.

`canvasPosition` object

Canvas position for React Flow visualization

2 child attributes

`x` number (double)

X coordinate on the canvas

`y` number (double)

Y coordinate on the canvas

`childStepIds` array of string 

Read-only

Child workflow step IDs (steps that this step can transition to, UUID)

`createdAt` string (date-time) 

Read-only

When the workflow step was created

`eventAction` enum

The event action type for this workflow step.

Allowed values

* `EVENT_ACTION_CLIENT_REDIRECT` Redirect visitors to a destination URL
* `EVENT_ACTION_LINK_VISIT` Entry step triggered when the link is visited.
* `EVENT_ACTION_PASSWORD_VERIFY` Require visitors to enter a password before proceeding
* `EVENT_ACTION_FORM_SUBMIT` Present a data collection form to visitors
* `EVENT_ACTION_CONTACT_CARD` Generate a vCard (VCF) response with contact information
* `EVENT_ACTION_MULTI_LINK` A page of buttons where each one continues into more workflow: the button leads to a next step, not straight out. Records which button the visitor pressed, so use it over SOCIAL\_LINKS\_PAGE when that choice is worth measuring or when a branch needs to do more than redirect. This is the menu step: for several documents or PDFs, give each one a button connected to an OPEN\_MEDIA step for media uploaded to the media library, or to a CLIENT\_REDIRECT when the document is already hosted at a URL.
* `EVENT_ACTION_VISIT_TYPE_CONDITION` Route visitors based on whether it's a first or returning visit
* `EVENT_ACTION_COUNTRY_CONDITION` Route visitors based on their country location
* `EVENT_ACTION_DAY_OF_WEEK_CONDITION` Route visitors based on day of week
* `EVENT_ACTION_TIME_OF_DAY_CONDITION` Route visitors based on time of day
* `EVENT_ACTION_DAY_OF_MONTH_CONDITION` Route visitors based on day of month
* `EVENT_ACTION_SPECIFIC_DATE_CONDITION` Route visitors based on specific calendar dates
* `EVENT_ACTION_SOCIAL_LINKS_PAGE` A page of buttons that each leave for an external URL. Social profiles are the common case, not the only one: app stores, docs, booking pages and storefronts all work, and the name is the only thing about it that is social. It is an exit step, so the visitor leaves from here.
* `EVENT_ACTION_DEVICE_TYPE_CONDITION` Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)
* `EVENT_ACTION_DEVICE_PLATFORM_CONDITION` Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)
* `EVENT_ACTION_DEVICE_BROWSER_CONDITION` Route visitors based on their browser: a browser family (Chrome, Safari, Firefox...) or the in-app browser of the app a link was opened in (Instagram, TikTok, Facebook, LinkedIn...)
* `EVENT_ACTION_DEVICE_BRAND_CONDITION` Route visitors based on hardware brand (e.g. Apple, Samsung, Google)
* `EVENT_ACTION_DEVICE_ACTOR_CONDITION` Route visitors based on actor classification: HUMAN, BOT, AGENT, AUTOMATED or UNKNOWN. AGENT is an AI agent that names itself (GPTBot, Claude-User, Perplexity-User...). AUTOMATED is a browser driven by software, whoever is behind it: headless Chrome from its request, and a visible browser under automation once a link with the Advanced data collection level has read navigator.webdriver, from that device's next visit on.
* `EVENT_ACTION_VISITOR_DATA_CONDITION` Route visitors based on their profile data or custom attributes
* `EVENT_ACTION_THANK_YOU_PAGE` Display a final thank you / completion message (exit step)
* `EVENT_ACTION_MESSAGE_PAGE` Text with ONE way onward: a single button, or a timer that moves the visitor automatically. It carries no list of destinations, so a page that should offer a choice between two or more places is not this step. Use SOCIAL\_LINKS\_PAGE when the choices leave for external URLs, or MULTI\_LINK when each choice continues into more workflow. Never put links, documents or PDFs on it: it is a message, nothing else.
* `EVENT_ACTION_OPEN_MEDIA` Hand the visitor one piece of uploaded media, opened in their browser (exit step): a PDF, an image (PNG, JPEG, WebP, SVG) or an MP4 video. The visitor is sent straight to the media, with no page of its own. Any media of the library can be opened: it is uploaded once and referenced by its mediaId; swapping it means pointing the step at another media item, and the QR code never changes.
* `EVENT_ACTION_LOCATION_REQUEST` Ask the visitor for their precise location (GPS) through the browser, with their permission (composite: two branches, "location" when it was shared, "else" when it was refused, skipped or is unavailable).
* `EVENT_ACTION_LANGUAGE_CONDITION` Route visitors based on their phone or browser language (the first language it sends, matched on its two-letter ISO 639-1 base, so "fr" catches fr-FR and fr-CA)
* `EVENT_ACTION_CHAT_BOT` A conversation with one of the workspace's agents that collects visitor attributes (composite: two branches, "completed" when every required objective is known, "else" otherwise)
* `EVENT_ACTION_TRAFFIC_SPLIT` Split visitors between 2 to 20 variants by percentage, for an A/B test (composite: one branch per variant, no "else"). Assignment is deterministic and sticky per device by default. See TrafficSplitPayload.

`id` string

The unique identifier of the workflow step (UUID)

`kind` enum 

Read-only

The kind of workflow step (entry, exit, etc.) - read-only, determined by server.

Allowed values

* `KIND_ENTRY` Entry steps are automatically triggered when a visitor reaches the workflow
* `KIND_EXIT` Exit steps finalize the workflow (commonly a redirect)
* `KIND_INTERACTION` Interaction steps require visitor input (forms, passwords, etc.)
* `KIND_CONDITION` Condition steps evaluate logic and route to different next steps

`linkId` string

The link ID this workflow step belongs to (UUID)

`nextCanGoBack` boolean 

Read-only

Whether a page added after this step could show a back button: this step is a page, or a page comes before it. False for a step no visitor reaches.

`nodeType` enum 

Read-only

The node type of workflow step (composite, atomic) - read-only, determined by server.

This tells you how many exits the step has, which the branches field then lists: ATOMIC steps have one, COMPOSITE steps have one per button/option plus a fallback. Connect any of them by connecting that step exit.

See WorkflowStepNodeType enum for detailed documentation.

Allowed values

* `NODE_TYPE_COMPOSITE` Composite steps have one exit per button, option or range, plus "else" for a condition's fallback. Examples: MULTI\_LINK, VISIT\_TYPE\_CONDITION, COUNTRY\_CONDITION, DAY\_OF\_WEEK\_CONDITION, TIME\_OF\_DAY\_CONDITION, DAY\_OF\_MONTH\_CONDITION, SPECIFIC\_DATE\_CONDITION, DEVICE\_\*\_CONDITION, VISITOR\_DATA\_CONDITION
* `NODE_TYPE_ATOMIC` Atomic steps have exactly one exit, branch id "next". Exit steps (THANK\_YOU\_PAGE, CONTACT\_CARD, SOCIAL\_LINKS\_PAGE, CLIENT\_REDIRECT) are atomic but end the journey, so they have no branches at all. Examples: LINK\_VISIT, PASSWORD\_VERIFY, FORM\_SUBMIT, MESSAGE\_PAGE

`parentStepIds` array of string 

Read-only

Parent workflow step IDs (steps that can transition into this step, UUID)

`payload` object

The payload data for this workflow step (varies by event action)

26 child attributes

`chatBot` object

Chat bot payload for EVENT\_ACTION\_CHAT\_BOT

9 child attributes

`agentId` string

The agent that talks to the visitor (UUID)

`elseNextStepId` string

Step the visitor goes to when the chat ends without them ("else" branch). Unset follows the "completed" branch.

`maxExchanges` integer (int32)

Most messages the visitor can send before the step moves on. Defaults to 15.

`nextStepId` string

Step the visitor goes to once every required objective is known ("completed" branch)

`objectives` array of object

What the conversation must learn about the visitor

6 child attributes

`explanation` string

What the agent needs to understand to ask for it and recognise a good answer. For a consent objective, the wording the visitor agrees to (the label when empty): the agent asks it in substance as a yes or no question.

`key` string

Visitor attribute key the answer is saved under. $email, $phone, $firstName and $lastName fill the visitor's identity. $marketingConsent is the key of a FORM\_FIELD\_TYPE\_CONSENT objective, and only of it.

`label` string

Short name of what is asked, shown in the dashboard

`options` array of object

Allowed answers for RADIO, CHECKBOX and DROPDOWN

`required` boolean

Whether the conversation must collect it to be completed

`type` enum

Kind of value, which decides how the answer is checked and stored. FORM\_FIELD\_TYPE\_CONSENT asks for marketing consent: key $marketingConsent, granted or denied as the agent judges the visitor's reply, whatever their words, and each answer kept as proof with the question asked and the reply.

Allowed values

* `FORM_FIELD_TYPE_TEXT`
* `FORM_FIELD_TYPE_EMAIL`
* `FORM_FIELD_TYPE_PHONE`
* `FORM_FIELD_TYPE_TEXTAREA`
* `FORM_FIELD_TYPE_RADIO`
* `FORM_FIELD_TYPE_CHECKBOX`
* `FORM_FIELD_TYPE_DROPDOWN`
* `FORM_FIELD_TYPE_NUMBER`
* `FORM_FIELD_TYPE_DATE`
* `FORM_FIELD_TYPE_RATING`
* `FORM_FIELD_TYPE_CONSENT` A checkbox where the visitor agrees to the workspace's marketing, in the workspace's own words (the label), never pre-ticked. Its key is always $marketingConsent: granted when ticked, denied when not, and each answer is kept as proof (who, the wording, where, when). Integrations subscribe only visitors who granted it; a visitor data condition can route on it. As a chat bot objective, the agent asks it as a yes or no question instead.

`openingMessage` string

First message the agent sends. Empty lets the agent greet the visitor itself.

`skipEnabled` boolean

Whether the visitor can leave the chat with a skip button, taking the "else" branch

`skipLabel` string

Label of the skip button

`skipWhenKnown` boolean

Pass over the chat when every required objective is already known about the visitor

`clientRedirect` object

Client redirect payload for EVENT\_ACTION\_CLIENT\_REDIRECT

2 child attributes

`conversionTracking` boolean

Controls whether lbid is preserved in redirect URL. Forced on for a Typeform, Tally, Jotform, Paperform or Google Forms destination: left out it turns on, false is refused (CONVERSION\_TRACKING\_REQUIRED). Typeform gets the lbid after the #.

`destination` string

Fully qualified URL used for the redirect

`countryCondition` object

Country condition payload for EVENT\_ACTION\_COUNTRY\_CONDITION

2 child attributes

`countries` array of object

Country routing configuration

2 child attributes

`countryCode` string

ISO 3166-1 alpha-2 country code (e.g., "US", "FR", "GB")

`nextStepId` string

Workflow step ID to route to for this country (UUID)

`elseNextStepId` string

Workflow step ID to route to if country doesn't match any configured options (UUID)

`dayOfMonthCondition` object

Day of month condition payload for EVENT\_ACTION\_DAY\_OF\_MONTH\_CONDITION

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if no options match (UUID)

`options` array of object

Day of month routing options

4 child attributes

`dayOfMonth` integer (int32)

Day of month (1-31, or -1 for last day)

`id` string

Unique identifier for this option

`name` string

Optional friendly name for this option

`nextStepId` string

Workflow step ID to route to when this option matches (UUID)

`dayOfWeekCondition` object

Day of week condition payload for EVENT\_ACTION\_DAY\_OF\_WEEK\_CONDITION

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if no options match (UUID)

`options` array of object

Day of week routing options

4 child attributes

`daysOfWeek` array of integer (int32)

Days of week (0=Sunday, 1=Monday, ..., 6=Saturday).

Days of the week: 0=Sunday, 1=Monday, 2=Tuesday, 3=Wednesday, 4=Thursday, 5=Friday, 6=Saturday

`id` string

Unique identifier for this option

`name` string

Optional friendly name for this option

`nextStepId` string

Workflow step ID to route to when this option matches (UUID)

`deviceActorCondition` object

Device actor condition payload for EVENT\_ACTION\_DEVICE\_ACTOR\_CONDITION. An AGENT option matches AI agents that name themselves. An AUTOMATED option matches headless browsers on every visit, and a visible browser under automation from its second visit, once the link collects data at the Advanced level, which lets the page read navigator.webdriver. To treat both the same, route AGENT and AUTOMATED to the same step.

2 child attributes

`elseNextStepId` string

`options` array of object

4 child attributes

`id` string

`name` string

`nextStepId` string

`value` enum

Actor to match.

Allowed values

* `DEVICE_ACTOR_CONDITION_VALUE_HUMAN`
* `DEVICE_ACTOR_CONDITION_VALUE_BOT`
* `DEVICE_ACTOR_CONDITION_VALUE_AGENT`
* `DEVICE_ACTOR_CONDITION_VALUE_UNKNOWN`
* `DEVICE_ACTOR_CONDITION_VALUE_AUTOMATED`

`deviceBrandCondition` object

2 child attributes

`elseNextStepId` string

`options` array of object

4 child attributes

`id` string

`name` string

`nextStepId` string

`value` enum

Hardware brand to match.

Allowed values

* `DEVICE_BRAND_CONDITION_VALUE_APPLE`
* `DEVICE_BRAND_CONDITION_VALUE_SAMSUNG`
* `DEVICE_BRAND_CONDITION_VALUE_GOOGLE`
* `DEVICE_BRAND_CONDITION_VALUE_HUAWEI`
* `DEVICE_BRAND_CONDITION_VALUE_XIAOMI`
* `DEVICE_BRAND_CONDITION_VALUE_ONEPLUS`

`deviceBrowserCondition` object

2 child attributes

`elseNextStepId` string

`options` array of object

5 child attributes

`id` string

`minAppVersion` string

Lowest app version this option matches, as dotted numbers ("400" or "447.0.1"). Only with a single app's value (Instagram, TikTok...), not with a browser family, ANY\_IN\_APP\_BROWSER, OTHER\_IN\_APP\_BROWSER, or Pinterest, which writes no version. A visit whose app version is unknown does not match.

`name` string

`nextStepId` string

`value` enum

Browser family or in-app browser to match.

Allowed values

* `DEVICE_BROWSER_CONDITION_VALUE_CHROME` Chrome, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_SAFARI` Safari, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_FIREFOX` Firefox, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_EDGE` Edge, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_OPERA` Opera, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_SAMSUNG_BROWSER` Samsung Internet, in a regular browser
* `DEVICE_BROWSER_CONDITION_VALUE_ANY_IN_APP_BROWSER` Any app's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_INSTAGRAM` Instagram's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_FACEBOOK` Facebook's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_MESSENGER` Messenger's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_THREADS` Threads' in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_TIKTOK` TikTok's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_SNAPCHAT` Snapchat's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_LINKEDIN` LinkedIn's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_PINTEREST` Pinterest's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_X` X's (Twitter's) in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_WECHAT` WeChat's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_LINE` LINE's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_GOOGLE_APP` The Google app's in-app browser
* `DEVICE_BROWSER_CONDITION_VALUE_OTHER_IN_APP_BROWSER` Another app's in-app browser that does not name the app (Android webview)

`devicePlatformCondition` object

2 child attributes

`elseNextStepId` string

`options` array of object

4 child attributes

`id` string

`name` string

`nextStepId` string

`value` enum

Platform / operating system to match.

Allowed values

* `DEVICE_PLATFORM_CONDITION_VALUE_IOS`
* `DEVICE_PLATFORM_CONDITION_VALUE_ANDROID`
* `DEVICE_PLATFORM_CONDITION_VALUE_WINDOWS`
* `DEVICE_PLATFORM_CONDITION_VALUE_MACOS`
* `DEVICE_PLATFORM_CONDITION_VALUE_LINUX`
* `DEVICE_PLATFORM_CONDITION_VALUE_CHROMEOS`

`deviceTypeCondition` object

2 child attributes

`elseNextStepId` string

`options` array of object

4 child attributes

`id` string

`name` string

`nextStepId` string

`value` enum

Device type to match.

Allowed values

* `DEVICE_TYPE_CONDITION_VALUE_MOBILE`
* `DEVICE_TYPE_CONDITION_VALUE_DESKTOP`
* `DEVICE_TYPE_CONDITION_VALUE_TABLET`
* `DEVICE_TYPE_CONDITION_VALUE_UNKNOWN`

`form` object

Form data collection payload for EVENT\_ACTION\_FORM\_SUBMIT

7 child attributes

`autoSkipIfKnown` boolean

Automatically skip the form when required data is already known

`formDescription` string

Body copy rendered above the form fields

`formFields` array of object

Form fields to present to visitors

11 child attributes

`defaultValue` string

Value pre-filled when the form renders

`helpText` string

Helper copy displayed under the input

`id` string

Unique identifier for this field within the form

`key` string

Field key for data storage (maps to visitor attributes or system fields like $email)

`label` string

Display label for the field

`options` array of object

Options for radio, checkbox, or select fields

`order` integer (int32)

Display order (for drag-and-drop reordering)

`placeholder` string

Placeholder text

`required` boolean

Whether this field is required

`type` enum

Allowed values

* `FORM_FIELD_TYPE_TEXT`
* `FORM_FIELD_TYPE_EMAIL`
* `FORM_FIELD_TYPE_PHONE`
* `FORM_FIELD_TYPE_TEXTAREA`
* `FORM_FIELD_TYPE_RADIO`
* `FORM_FIELD_TYPE_CHECKBOX`
* `FORM_FIELD_TYPE_DROPDOWN`
* `FORM_FIELD_TYPE_NUMBER`
* `FORM_FIELD_TYPE_DATE`
* `FORM_FIELD_TYPE_RATING`
* `FORM_FIELD_TYPE_CONSENT` A checkbox where the visitor agrees to the workspace's marketing, in the workspace's own words (the label), never pre-ticked. Its key is always $marketingConsent: granted when ticked, denied when not, and each answer is kept as proof (who, the wording, where, when). Integrations subscribe only visitors who granted it; a visitor data condition can route on it. As a chat bot objective, the agent asks it as a yes or no question instead.

`validationPattern` string

Additional field-specific configuration Optional regex applied client-side to validate the field value

`formTitle` string

Optional heading shown on the visitor form

`skipButtonText` string

Custom text for the skip button (defaults to "Skip for now" when skipForm is enabled)

`skipForm` boolean

Whether the visitor experience should offer a "Skip" option and record an empty submission

`submitButtonText` string

Custom text for the submit button (defaults to "Submit")

`languageCondition` object

Language condition payload for EVENT\_ACTION\_LANGUAGE\_CONDITION. The visitor's language is the first one their phone or browser sends; visitors whose language is not listed, or who send none, take the "else" branch.

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if the language doesn't match any configured option (UUID)

`languages` array of object

Language routing configuration, one branch per language code

2 child attributes

`languageCode` string

Two-letter ISO 639-1 language code, lowercase (e.g., "en", "fr", "es"). Matches every regional variant of the language: "fr" matches fr-FR and fr-CA.

`nextStepId` string

Workflow step ID to route to for this language (UUID)

`linkVisit` object

Entry payload for EVENT\_ACTION\_LINK\_VISIT (currently no specific fields).

Reserved for future link visit specific configuration

`locationRequest` object

Location request payload for EVENT\_ACTION\_LOCATION\_REQUEST

8 child attributes

`askOnce` boolean

Ask only once per device: a device that already shared its location on this step passes over it on later visits, taking the "location" branch

`buttonLabel` string

Label of the button that triggers the browser's location prompt

`description` string

Text under the heading, saying why the location is asked for

`elseNextStepId` string

Step the visitor goes to when the location is refused, skipped or unavailable ("else" branch)

`nextStepId` string

Step the visitor goes to once the location is shared ("location" branch)

`skipEnabled` boolean

Whether the page offers a skip button, which takes the "else" branch without triggering the browser prompt

`skipLabel` string

Label of the skip button

`title` string

Heading shown on the page

`messagePage` object

A mid-flow informational page with mandatory navigation

5 child attributes

`buttonLabel` string

Label for the navigation button (only used when navigationType is BUTTON, defaults to "Continue")

`description` string

Optional descriptive text below the title

`navigationType` enum 

Required

How the visitor proceeds to the next step.

Allowed values

* `MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON` Visitor clicks a button to proceed
* `MESSAGE_PAGE_NAVIGATION_TYPE_TIMER` Visitor is automatically redirected after a timer expires

`timerSeconds` integer (int32)

Seconds before auto-redirect (only used when navigationType is TIMER)

`title` string 

Required

The main heading displayed on the message page

`multiLink` object

Multi-link page payload for EVENT\_ACTION\_MULTI\_LINK

3 child attributes

`buttons` array of object

Buttons to display on the multi-link page

4 child attributes

`id` string

Unique identifier for this button

`label` string

Display label for the button

`nextStepId` string

The ID of the next workflow step to transition to (UUID)

`order` integer (int32)

Display order for buttons

`description` string

Optional description displayed on the multi-link page

`title` string

Optional title displayed on the multi-link page

`openMedia` object

Hands the visitor one piece of media from the media library (EVENT\_ACTION\_OPEN\_MEDIA)

1 child attribute

`mediaId` string 

Required

The media item (UUID) handed to the visitor: any ready media of the workspace (a PDF, an image or an MP4 video).

`password` object

Password protection payload for EVENT\_ACTION\_PASSWORD\_VERIFY

3 child attributes

`description` string

Additional helper copy displayed under the password prompt

`password` string

Plaintext password visitors must enter to continue the workflow

`title` string

Heading shown above the password prompt

`socialLinks` object

Social links page payload for EVENT\_ACTION\_SOCIAL\_LINKS\_PAGE

4 child attributes

`description` string

Optional description displayed on the social links page

`displayStyle` enum

Display style for the social links (defaults to detailed if not specified).

Allowed values

* `SOCIAL_LINKS_DISPLAY_STYLE_DETAILED` Display icon with text label (default)
* `SOCIAL_LINKS_DISPLAY_STYLE_COMPACT` Display icons only in a compact row

`links` array of object

Social links to display (up to 10)

4 child attributes

`id` string

Unique identifier for this link

`order` integer (int32)

Display order for links (order 1 will be highlighted)

`platform` string

Platform identifier picking the icon. Leave it empty and the API names it from the URL, which is what you normally want. Known values: appstore, playstore, instagram, tiktok, twitter, facebook, youtube, linkedin, github, medium, whatsapp, telegram, discord, slack, spotify, applemusic, twitch, snapchat, pinterest, reddit, calendly, website. Supported platforms: instagram, tiktok, twitter, facebook, website, youtube, linkedin, github, whatsapp

`url` string

Destination URL for the link

`title` string

Optional title displayed on the social links page

`specificDateCondition` object

Specific date condition payload for EVENT\_ACTION\_SPECIFIC\_DATE\_CONDITION

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if no options match (UUID)

`options` array of object

Specific date routing options

6 child attributes

`day` integer (int32)

Day of month (1-31)

`id` string

Unique identifier for this option

`month` integer (int32)

Month (1-12)

`name` string

Optional friendly name for this option

`nextStepId` string

Workflow step ID to route to when this option matches (UUID)

`year` integer (int32)

Optional year for one-time events.

Year (optional, for one-time dates)

`thankYouPage` object

A terminal exit page displaying a title and optional description

2 child attributes

`description` string

Optional descriptive text below the title

`title` string 

Required

The main heading displayed on the thank you page

`timeOfDayCondition` object

Time of day condition payload for EVENT\_ACTION\_TIME\_OF\_DAY\_CONDITION

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if no ranges match (UUID)

`ranges` array of object

Time range routing options

5 child attributes

`endTime` string

End time in 24-hour format (HH:MM)

`id` string

Unique identifier for this range

`name` string

Optional friendly name for this range

`nextStepId` string

Workflow step ID to route to when this range matches (UUID)

`startTime` string

Start time in 24-hour format (HH:MM)

`trafficSplit` object

Traffic split payload for EVENT\_ACTION\_TRAFFIC\_SPLIT, Linkbreakers' A/B test. Invisible to the visitor: no page, the visit goes straight to the variant's next step. 2 to 20 variants, weights sum to exactly 100, there is no else branch because the weights cover every visitor.

Sticky is the default: assignment is deterministic and per device. The variant is computed from the step id and the device id, nothing is stored, so the same device gets the same variant on every visit. A different split on the same device is an independent assignment. The device is the workspace's device cookie, so a new device, private browsing or some in-app browsers count as a new visitor.

With sticky set to false, the variant is computed from the step id and the visit's event id instead: every visit is assigned afresh, so one person can see several variants, while one visit stays on its variant across a form or a retry. That suits sharing traffic. For an A/B test, leave sticky on.

Percentages are approximate at low traffic: on a 50/50, expect about plus or minus 10 points at 100 visitors, 3 at 1,000 and 1 at 10,000.

Changing weights only moves visitors near the boundaries you changed: going from 90/10 to 80/20 only moves visitors from the first variant to the second. With three or more variants, a shift can move a few more than the difference. Keep variants in the same order, since the order decides who lands where.

To end a test, set the weights to 100 and 0: everyone goes to the winner, including those who had the other variant. To target a test, place a condition before the split, not inside it: a split has no rules of its own.

2 child attributes

`sticky` boolean

Keep returning visitors on the same variant. Left out means true, the default, and for an A/B test it should stay on. Set false only to share traffic: each visit is then assigned on its own by weight, so one person can see several variants. It is a draw per visit, not a strict round-robin. On an update, leaving this out keeps the current setting.

`variants` array of object

The variants, from 2 to 20\. Their order decides who lands where, so keep it stable across updates.

4 child attributes

`id` string

Stable id of this variant, and its branch id. Leave it empty on a new variant: the server generates it once and never reuses it. Send it back unchanged on every update so results and connections stay with the variant.

`label` string

Name people read, required (e.g. "A", "Short form")

`nextStepId` string

Workflow step this variant leads to (UUID). A variant with none sends its visitors to the link's fallback destination.

`weight` integer (int32)

Share of visitors, in whole percent from 0 to 100\. The weights of all variants must sum to exactly 100\. A variant at 0 receives no new visitors.

`vcard` object

vCard payload for EVENT\_ACTION\_CONTACT\_CARD

18 child attributes

`buttonLabel` string

Label displayed on the contact button

`city` string

City for the vCard address

`country` string

Country for the vCard address

`email` string

Email address for the vCard

`firstName` string

First name for the vCard

`lastName` string

Last name for the vCard

`organization` string

Organization/company name for the vCard

`phone` string

Phone number for the vCard

`phoneIsWhatsapp` boolean

Whether the phone number is also a WhatsApp number (shows WhatsApp link on contact card)

`phoneSmsEnabled` boolean

Whether visitors can also text the phone number (shows a "Send a text" action that opens the SMS app)

`postalCode` string

Postal/ZIP code for the vCard address

`saveButtonEnabled` boolean

Whether the card shows its save button ("Add to contacts"). Defaults to true when unset.

`socialLinks` array of object

Optional social links to display on the contact card and embed in the vCard

2 child attributes

`platform` string

Platform identifier picking the icon. Leave it empty and the API names it from the URL, which is what you normally want. Known values: appstore, playstore, instagram, tiktok, twitter, facebook, youtube, linkedin, github, medium, whatsapp, telegram, discord, slack, spotify, applemusic, twitch, snapchat, pinterest, reddit, calendly, website.

`url` string

Profile URL for this social platform

`state` string

State/province for the vCard address

`streetAddress` string

Street address for the vCard

`title` string

Job title for the vCard

`walletPassEnabled` boolean

Whether the card offers "Add to Apple Wallet" and "Add to Google Wallet" buttons, which save the card as a wallet pass holding a QR code of the link. Off by default. Each button only shows once that wallet is available on Linkbreakers (see GetWalletPassSupport).

`website` string

Website URL for the vCard

`visitTypeCondition` object

Visit type condition payload for EVENT\_ACTION\_VISIT\_TYPE\_CONDITION

2 child attributes

`elseNextStepId` string

Workflow step ID to route to if the visit type does not match any configured options (UUID)

`options` array of object

Visit type routing options

2 child attributes

`nextStepId` string

Workflow step ID to route to for this visit type (UUID)

`value` string

Visit type value to match (e.g. FIRST, RETURNING)

`visitorDataCondition` object

2 child attributes

`elseNextStepId` string

`options` array of object

5 child attributes

`attributeKey` string

Visitor attribute key to check (e.g., "age", "$email", "company")

`comparisonValue` string

Value to compare against. Not used by STRING\_IS\_EMPTY, STRING\_IS\_NOT\_EMPTY, BOOLEAN\_IS\_TRUE and BOOLEAN\_IS\_FALSE.

`id` string

`nextStepId` string

`operator` string

Operator for comparison, exactly one of: STRING\_EQUALS, STRING\_NOT\_EQUALS, STRING\_CONTAINS, STRING\_NOT\_CONTAINS, STRING\_STARTS\_WITH, STRING\_ENDS\_WITH, STRING\_IS\_EMPTY, STRING\_IS\_NOT\_EMPTY, NUMBER\_EQUALS, NUMBER\_NOT\_EQUALS, NUMBER\_GREATER\_THAN, NUMBER\_LESS\_THAN, NUMBER\_GREATER\_OR\_EQUAL, NUMBER\_LESS\_OR\_EQUAL, DATE\_EQUALS, DATE\_BEFORE, DATE\_AFTER, DATE\_BEFORE\_OR\_EQUAL, DATE\_AFTER\_OR\_EQUAL, BOOLEAN\_IS\_TRUE, BOOLEAN\_IS\_FALSE. These are the VisitorAttributeFilterOperator names without the VISITOR\_ATTRIBUTE\_FILTER\_OPERATOR\_ prefix.

`rendersPage` boolean 

Read-only

Whether visitors see this step as a page. Page steps take the options every page has, such as backButton; redirects and conditions do not.

`updatedAt` string (date-time) 

Read-only

When the workflow step was last updated

Example workflow step

```json
{
  "attributeCapture": {
    "enabled": true,
    "writes": [
      {
        "key": "looking_for",
        "mode": "ATTRIBUTE_WRITE_MODE_SET",
        "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
        "value": "{{choice.label}}"
      }
    ]
  },
  "backButton": {
    "enabled": true,
    "label": "Back to menu"
  },
  "backButtonAvailable": true,
  "branches": [
    {
      "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
      "label": "Short form",
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    }
  ],
  "canvasPosition": {
    "x": 320,
    "y": 180
  },
  "childStepIds": [
    "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
  ],
  "createdAt": "2026-03-14T09:30:00Z",
  "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
  "id": "987fcdeb-a321-45e6-b789-123456789012",
  "kind": "KIND_INTERACTION",
  "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
  "nextCanGoBack": true,
  "nodeType": "NODE_TYPE_COMPOSITE",
  "parentStepIds": [
    "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
  ],
  "payload": {
    "chatBot": {
      "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "maxExchanges": 15,
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "objectives": [
        {
          "explanation": "The company the visitor works for. A freelancer can answer their own name.",
          "key": "company",
          "label": "Company",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL"
        }
      ],
      "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
      "skipEnabled": true,
      "skipLabel": "Skip to the menu",
      "skipWhenKnown": true
    },
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "countryCondition": {
      "countries": [
        {
          "countryCode": "US",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ],
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
    },
    "dayOfMonthCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "dayOfMonth": 1,
          "id": "option-1",
          "name": "First of Month",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "dayOfWeekCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "daysOfWeek": [
            1,
            2,
            3,
            4,
            5
          ],
          "id": "option-1",
          "name": "Weekdays",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "deviceActorCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Bots",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
        }
      ]
    },
    "deviceBrandCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Apple Devices",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
        }
      ]
    },
    "deviceBrowserCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "minAppVersion": "400",
          "name": "Chrome Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
        }
      ]
    },
    "devicePlatformCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "iOS Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
        }
      ]
    },
    "deviceTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Desktop Users",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
        }
      ]
    },
    "form": {
      "autoSkipIfKnown": true,
      "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
      "formFields": [
        {
          "defaultValue": "jules.martin@example.com",
          "helpText": "We send tonight's specials with the menu.",
          "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
          "key": "$email",
          "label": "Email",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "order": 1,
          "placeholder": "jules.martin@example.com",
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL",
          "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
        }
      ],
      "formTitle": "Get the spring menu",
      "skipButtonText": "Skip for now",
      "skipForm": true,
      "submitButtonText": "Show me the menu"
    },
    "languageCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "languages": [
        {
          "languageCode": "fr",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "linkVisit": {},
    "locationRequest": {
      "askOnce": true,
      "buttonLabel": "Share my location",
      "description": "We use it to show you the nearest store.",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "skipEnabled": true,
      "skipLabel": "Not now",
      "title": "Share your location"
    },
    "messagePage": {
      "buttonLabel": "See the menu",
      "description": "Our spring menu is served on the terrace from noon to 10 pm.",
      "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
      "timerSeconds": 5,
      "title": "Welcome to Hotel Lumiere"
    },
    "multiLink": {
      "buttons": [
        {
          "id": "btn-1",
          "label": "Continue to Website",
          "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "order": 1
        }
      ],
      "description": "Select one of the options below to continue",
      "title": "Choose your destination"
    },
    "openMedia": {
      "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
    },
    "password": {
      "description": "Enter the code your server gave you.",
      "password": "lumiere2026",
      "title": "Chef's tasting menu"
    },
    "socialLinks": {
      "description": "Follow us on your favorite platform",
      "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
      "links": [
        {
          "id": "link-1",
          "order": 1,
          "platform": "instagram",
          "url": "https://instagram.com/username"
        }
      ],
      "title": "Connect with us"
    },
    "specificDateCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "day": 25,
          "id": "option-1",
          "month": 12,
          "name": "Christmas",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "year": 2024
        }
      ]
    },
    "thankYouPage": {
      "description": "The spring menu is on its way to your inbox.",
      "title": "Merci, see you at the table!"
    },
    "timeOfDayCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "ranges": [
        {
          "endTime": "17:00",
          "id": "range-1",
          "name": "Business Hours",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "startTime": "09:00"
        }
      ]
    },
    "trafficSplit": {
      "sticky": true,
      "variants": [
        {
          "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
          "label": "Short form",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "weight": 50
        }
      ]
    },
    "vcard": {
      "buttonLabel": "Add to contacts",
      "city": "San Francisco",
      "country": "United States",
      "email": "hello@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "organization": "Acme Corporation",
      "phone": "+33123456789",
      "phoneIsWhatsapp": true,
      "phoneSmsEnabled": true,
      "postalCode": "94102",
      "saveButtonEnabled": true,
      "socialLinks": [
        {
          "platform": "linkedin",
          "url": "https://linkedin.com/in/janedoe"
        }
      ],
      "state": "CA",
      "streetAddress": "123 Main Street",
      "title": "Software Engineer",
      "walletPassEnabled": true,
      "website": "https://acme.com"
    },
    "visitTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "FIRST"
        }
      ]
    },
    "visitorDataCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "attributeKey": "age",
          "comparisonValue": "18",
          "id": "option-1",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "operator": "NUMBER_GREATER_THAN"
        }
      ]
    }
  },
  "rendersPage": true,
  "updatedAt": "2026-03-18T16:05:00Z"
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link to list workflow steps for (UUID)

`pageSize` integer (int64) 

query

The maximum number of workflow steps to return (optional)

`pageToken` string 

query

The token for retrieving the next page of results (optional)

`cursor` string 

query

Opaque cursor from the previous page's nextPageToken. Same as pageToken; when both are sent, pageToken wins.

### Response

200

`nextPageToken` string

Token for retrieving the next page of results.

Cursor to fetch the next page of workflow steps

`totalCount` integer (int64)

How many steps this link has in total, so a client can tell a complete answer from a page of one. A local-first client reads absence from this list as the step having been deleted, and may only do so when the count it was given matches what it received. The count covers the link asked about rather than the workspace, which is the only sense in which this list is ever whole.

`workflowSteps` array of object

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "nextPageToken": "eyJzdGVwSWQiOiI5ODcifQ==",
  "totalCount": 4,
  "workflowSteps": [
    {
      "attributeCapture": {
        "enabled": true,
        "writes": [
          {
            "key": "looking_for",
            "mode": "ATTRIBUTE_WRITE_MODE_SET",
            "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
            "value": "{{choice.label}}"
          }
        ]
      },
      "backButton": {
        "enabled": true,
        "label": "Back to menu"
      },
      "backButtonAvailable": true,
      "branches": [
        {
          "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
          "label": "Short form",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ],
      "canvasPosition": {
        "x": 320,
        "y": 180
      },
      "childStepIds": [
        "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      ],
      "createdAt": "2026-03-14T09:30:00Z",
      "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
      "id": "987fcdeb-a321-45e6-b789-123456789012",
      "kind": "KIND_INTERACTION",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "nextCanGoBack": true,
      "nodeType": "NODE_TYPE_COMPOSITE",
      "parentStepIds": [
        "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
      ],
      "payload": {
        "chatBot": {
          "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
          "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
          "maxExchanges": 15,
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "objectives": [
            {
              "explanation": "The company the visitor works for. A freelancer can answer their own name.",
              "key": "company",
              "label": "Company",
              "required": true,
              "type": "FORM_FIELD_TYPE_EMAIL"
            }
          ],
          "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
          "skipEnabled": true,
          "skipLabel": "Skip to the menu",
          "skipWhenKnown": true
        },
        "clientRedirect": {
          "conversionTracking": true,
          "destination": "https://brand.example.com/checkout"
        },
        "countryCondition": {
          "countries": [
            {
              "countryCode": "US",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
            }
          ],
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
        },
        "dayOfMonthCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "dayOfMonth": 1,
              "id": "option-1",
              "name": "First of Month",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
            }
          ]
        },
        "dayOfWeekCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "daysOfWeek": [
                1,
                2,
                3,
                4,
                5
              ],
              "id": "option-1",
              "name": "Weekdays",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
            }
          ]
        },
        "deviceActorCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "id": "option-1",
              "name": "Bots",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
            }
          ]
        },
        "deviceBrandCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "id": "option-1",
              "name": "Apple Devices",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
            }
          ]
        },
        "deviceBrowserCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "id": "option-1",
              "minAppVersion": "400",
              "name": "Chrome Visitors",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
            }
          ]
        },
        "devicePlatformCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "id": "option-1",
              "name": "iOS Visitors",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
            }
          ]
        },
        "deviceTypeCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "id": "option-1",
              "name": "Desktop Users",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
            }
          ]
        },
        "form": {
          "autoSkipIfKnown": true,
          "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
          "formFields": [
            {
              "defaultValue": "jules.martin@example.com",
              "helpText": "We send tonight's specials with the menu.",
              "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
              "key": "$email",
              "label": "Email",
              "order": 1,
              "placeholder": "jules.martin@example.com",
              "required": true,
              "type": "FORM_FIELD_TYPE_EMAIL",
              "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
            }
          ],
          "formTitle": "Get the spring menu",
          "skipButtonText": "Skip for now",
          "skipForm": true,
          "submitButtonText": "Show me the menu"
        },
        "languageCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "languages": [
            {
              "languageCode": "fr",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
            }
          ]
        },
        "linkVisit": {},
        "locationRequest": {
          "askOnce": true,
          "buttonLabel": "Share my location",
          "description": "We use it to show you the nearest store.",
          "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "skipEnabled": true,
          "skipLabel": "Not now",
          "title": "Share your location"
        },
        "messagePage": {
          "buttonLabel": "See the menu",
          "description": "Our spring menu is served on the terrace from noon to 10 pm.",
          "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
          "timerSeconds": 5,
          "title": "Welcome to Hotel Lumiere"
        },
        "multiLink": {
          "buttons": [
            {
              "id": "btn-1",
              "label": "Continue to Website",
              "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
              "order": 1
            }
          ],
          "description": "Select one of the options below to continue",
          "title": "Choose your destination"
        },
        "openMedia": {
          "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
        },
        "password": {
          "description": "Enter the code your server gave you.",
          "password": "lumiere2026",
          "title": "Chef's tasting menu"
        },
        "socialLinks": {
          "description": "Follow us on your favorite platform",
          "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
          "links": [
            {
              "id": "link-1",
              "order": 1,
              "platform": "instagram",
              "url": "https://instagram.com/username"
            }
          ],
          "title": "Connect with us"
        },
        "specificDateCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "day": 25,
              "id": "option-1",
              "month": 12,
              "name": "Christmas",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "year": 2024
            }
          ]
        },
        "thankYouPage": {
          "description": "The spring menu is on its way to your inbox.",
          "title": "Merci, see you at the table!"
        },
        "timeOfDayCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "ranges": [
            {
              "endTime": "17:00",
              "id": "range-1",
              "name": "Business Hours",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "startTime": "09:00"
            }
          ]
        },
        "trafficSplit": {
          "sticky": true,
          "variants": [
            {
              "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
              "label": "Short form",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "weight": 50
            }
          ]
        },
        "vcard": {
          "buttonLabel": "Add to contacts",
          "city": "San Francisco",
          "country": "United States",
          "email": "hello@acme.com",
          "firstName": "Jane",
          "lastName": "Doe",
          "organization": "Acme Corporation",
          "phone": "+33123456789",
          "phoneIsWhatsapp": true,
          "phoneSmsEnabled": true,
          "postalCode": "94102",
          "saveButtonEnabled": true,
          "socialLinks": [
            {
              "platform": "linkedin",
              "url": "https://linkedin.com/in/janedoe"
            }
          ],
          "state": "CA",
          "streetAddress": "123 Main Street",
          "title": "Software Engineer",
          "walletPassEnabled": true,
          "website": "https://acme.com"
        },
        "visitTypeCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "value": "FIRST"
            }
          ]
        },
        "visitorDataCondition": {
          "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "options": [
            {
              "attributeKey": "age",
              "comparisonValue": "18",
              "id": "option-1",
              "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
              "operator": "NUMBER_GREATER_THAN"
            }
          ]
        }
      },
      "rendersPage": true,
      "updatedAt": "2026-03-18T16:05:00Z"
    }
  ]
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link (UUID)

`id` string 

path

Required

The ID of the workflow step to retrieve (UUID)

### Response

200

`workflowStep` object

One step of a link's workflow, the path a visitor follows after a scan. Defines what happens (a redirect, a gate, a form...) and which steps it connects to.

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "workflowStep": {
    "attributeCapture": {
      "enabled": true,
      "writes": [
        {
          "key": "looking_for",
          "mode": "ATTRIBUTE_WRITE_MODE_SET",
          "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
          "value": "{{choice.label}}"
        }
      ]
    },
    "backButton": {
      "enabled": true,
      "label": "Back to menu"
    },
    "backButtonAvailable": true,
    "branches": [
      {
        "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
        "label": "Short form",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      }
    ],
    "canvasPosition": {
      "x": 320,
      "y": 180
    },
    "childStepIds": [
      "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    ],
    "createdAt": "2026-03-14T09:30:00Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "987fcdeb-a321-45e6-b789-123456789012",
    "kind": "KIND_INTERACTION",
    "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "nextCanGoBack": true,
    "nodeType": "NODE_TYPE_COMPOSITE",
    "parentStepIds": [
      "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
    ],
    "payload": {
      "chatBot": {
        "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "maxExchanges": 15,
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "objectives": [
          {
            "explanation": "The company the visitor works for. A freelancer can answer their own name.",
            "key": "company",
            "label": "Company",
            "options": [],
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL"
          }
        ],
        "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
        "skipEnabled": true,
        "skipLabel": "Skip to the menu",
        "skipWhenKnown": true
      },
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "countryCondition": {
        "countries": [
          {
            "countryCode": "US",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ],
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
      },
      "dayOfMonthCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "dayOfMonth": 1,
            "id": "option-1",
            "name": "First of Month",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "dayOfWeekCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "daysOfWeek": [
              1,
              2,
              3,
              4,
              5
            ],
            "id": "option-1",
            "name": "Weekdays",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "deviceActorCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Bots",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
          }
        ]
      },
      "deviceBrandCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Apple Devices",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
          }
        ]
      },
      "deviceBrowserCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "minAppVersion": "400",
            "name": "Chrome Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
          }
        ]
      },
      "devicePlatformCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "iOS Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
          }
        ]
      },
      "deviceTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Desktop Users",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
          }
        ]
      },
      "form": {
        "autoSkipIfKnown": true,
        "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
        "formFields": [
          {
            "defaultValue": "jules.martin@example.com",
            "helpText": "We send tonight's specials with the menu.",
            "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
            "key": "$email",
            "label": "Email",
            "options": [],
            "order": 1,
            "placeholder": "jules.martin@example.com",
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL",
            "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
          }
        ],
        "formTitle": "Get the spring menu",
        "skipButtonText": "Skip for now",
        "skipForm": true,
        "submitButtonText": "Show me the menu"
      },
      "languageCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "languages": [
          {
            "languageCode": "fr",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "linkVisit": {},
      "locationRequest": {
        "askOnce": true,
        "buttonLabel": "Share my location",
        "description": "We use it to show you the nearest store.",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "skipEnabled": true,
        "skipLabel": "Not now",
        "title": "Share your location"
      },
      "messagePage": {
        "buttonLabel": "See the menu",
        "description": "Our spring menu is served on the terrace from noon to 10 pm.",
        "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
        "timerSeconds": 5,
        "title": "Welcome to Hotel Lumiere"
      },
      "multiLink": {
        "buttons": [
          {
            "id": "btn-1",
            "label": "Continue to Website",
            "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
            "order": 1
          }
        ],
        "description": "Select one of the options below to continue",
        "title": "Choose your destination"
      },
      "openMedia": {
        "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
      },
      "password": {
        "description": "Enter the code your server gave you.",
        "password": "lumiere2026",
        "title": "Chef's tasting menu"
      },
      "socialLinks": {
        "description": "Follow us on your favorite platform",
        "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
        "links": [
          {
            "id": "link-1",
            "order": 1,
            "platform": "instagram",
            "url": "https://instagram.com/username"
          }
        ],
        "title": "Connect with us"
      },
      "specificDateCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "day": 25,
            "id": "option-1",
            "month": 12,
            "name": "Christmas",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "year": 2024
          }
        ]
      },
      "thankYouPage": {
        "description": "The spring menu is on its way to your inbox.",
        "title": "Merci, see you at the table!"
      },
      "timeOfDayCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "ranges": [
          {
            "endTime": "17:00",
            "id": "range-1",
            "name": "Business Hours",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "startTime": "09:00"
          }
        ]
      },
      "trafficSplit": {
        "sticky": true,
        "variants": [
          {
            "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
            "label": "Short form",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "weight": 50
          }
        ]
      },
      "vcard": {
        "buttonLabel": "Add to contacts",
        "city": "San Francisco",
        "country": "United States",
        "email": "hello@acme.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "organization": "Acme Corporation",
        "phone": "+33123456789",
        "phoneIsWhatsapp": true,
        "phoneSmsEnabled": true,
        "postalCode": "94102",
        "saveButtonEnabled": true,
        "socialLinks": [
          {
            "platform": "linkedin",
            "url": "https://linkedin.com/in/janedoe"
          }
        ],
        "state": "CA",
        "streetAddress": "123 Main Street",
        "title": "Software Engineer",
        "walletPassEnabled": true,
        "website": "https://acme.com"
      },
      "visitTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "FIRST"
          }
        ]
      },
      "visitorDataCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "attributeKey": "age",
            "comparisonValue": "18",
            "id": "option-1",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "operator": "NUMBER_GREATER_THAN"
          }
        ]
      }
    },
    "rendersPage": true,
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`linkId` string 

path

Required

### Response

200

`issues` array of object

4 child attributes

`message` string

`severity` string

"error" or "warning"

`stepId` string

`stepType` string

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/validate" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "issues": [
    {
      "message": "4c7e1a92 (FORM_SUBMIT) has no outgoing connection — visitors will be stuck here",
      "severity": "error",
      "stepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "stepType": "FORM_SUBMIT"
    }
  ]
}
```

### Response

200

`appleWalletAvailable` boolean

Whether "Add to Apple Wallet" works (Apple Wallet pass signing is configured)

`googleWalletAvailable` boolean

Whether "Add to Google Wallet" works (a Google Wallet issuer is configured)

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X GET "https://api.linkbreakers.com/v1/workflow-steps/wallet-pass-support" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "appleWalletAvailable": true,
  "googleWalletAvailable": true
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link to create the workflow step for (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`attributeCapture` object

What the step saves to the visitor's profile (optional).

2 child attributes, the same as [attributeCapture in the workflow step object](#workflow-steps-object-attributecapture).

`backButton` object

The page's optional back button, which returns the visitor to the previous page (such as the menu) without wiring a connection. Page steps only: MESSAGE\_PAGE, MULTI\_LINK, CONTACT\_CARD, SOCIAL\_LINKS\_PAGE, FORM\_SUBMIT, PASSWORD\_VERIFY and THANK\_YOU\_PAGE. Hidden right after a scan.

2 child attributes

`enabled` boolean

Shows the button. Off keeps the label for when it is switched back on.

`label` string

Text on the button, up to 40 characters. Defaults to "Back".

`canvasPosition` object

Canvas position for React Flow visualization (optional)

2 child attributes

`x` number (double)

X coordinate on the canvas

`y` number (double)

Y coordinate on the canvas

`eventAction` enum

The event action type for this workflow step.

Allowed values

* `EVENT_ACTION_CLIENT_REDIRECT` Redirect visitors to a destination URL
* `EVENT_ACTION_LINK_VISIT` Entry step triggered when the link is visited.
* `EVENT_ACTION_PASSWORD_VERIFY` Require visitors to enter a password before proceeding
* `EVENT_ACTION_FORM_SUBMIT` Present a data collection form to visitors
* `EVENT_ACTION_CONTACT_CARD` Generate a vCard (VCF) response with contact information
* `EVENT_ACTION_MULTI_LINK` A page of buttons where each one continues into more workflow: the button leads to a next step, not straight out. Records which button the visitor pressed, so use it over SOCIAL\_LINKS\_PAGE when that choice is worth measuring or when a branch needs to do more than redirect. This is the menu step: for several documents or PDFs, give each one a button connected to an OPEN\_MEDIA step for media uploaded to the media library, or to a CLIENT\_REDIRECT when the document is already hosted at a URL.
* `EVENT_ACTION_VISIT_TYPE_CONDITION` Route visitors based on whether it's a first or returning visit
* `EVENT_ACTION_COUNTRY_CONDITION` Route visitors based on their country location
* `EVENT_ACTION_DAY_OF_WEEK_CONDITION` Route visitors based on day of week
* `EVENT_ACTION_TIME_OF_DAY_CONDITION` Route visitors based on time of day
* `EVENT_ACTION_DAY_OF_MONTH_CONDITION` Route visitors based on day of month
* `EVENT_ACTION_SPECIFIC_DATE_CONDITION` Route visitors based on specific calendar dates
* `EVENT_ACTION_SOCIAL_LINKS_PAGE` A page of buttons that each leave for an external URL. Social profiles are the common case, not the only one: app stores, docs, booking pages and storefronts all work, and the name is the only thing about it that is social. It is an exit step, so the visitor leaves from here.
* `EVENT_ACTION_DEVICE_TYPE_CONDITION` Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)
* `EVENT_ACTION_DEVICE_PLATFORM_CONDITION` Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)
* `EVENT_ACTION_DEVICE_BROWSER_CONDITION` Route visitors based on their browser: a browser family (Chrome, Safari, Firefox...) or the in-app browser of the app a link was opened in (Instagram, TikTok, Facebook, LinkedIn...)
* `EVENT_ACTION_DEVICE_BRAND_CONDITION` Route visitors based on hardware brand (e.g. Apple, Samsung, Google)
* `EVENT_ACTION_DEVICE_ACTOR_CONDITION` Route visitors based on actor classification: HUMAN, BOT, AGENT, AUTOMATED or UNKNOWN. AGENT is an AI agent that names itself (GPTBot, Claude-User, Perplexity-User...). AUTOMATED is a browser driven by software, whoever is behind it: headless Chrome from its request, and a visible browser under automation once a link with the Advanced data collection level has read navigator.webdriver, from that device's next visit on.
* `EVENT_ACTION_VISITOR_DATA_CONDITION` Route visitors based on their profile data or custom attributes
* `EVENT_ACTION_THANK_YOU_PAGE` Display a final thank you / completion message (exit step)
* `EVENT_ACTION_MESSAGE_PAGE` Text with ONE way onward: a single button, or a timer that moves the visitor automatically. It carries no list of destinations, so a page that should offer a choice between two or more places is not this step. Use SOCIAL\_LINKS\_PAGE when the choices leave for external URLs, or MULTI\_LINK when each choice continues into more workflow. Never put links, documents or PDFs on it: it is a message, nothing else.
* `EVENT_ACTION_OPEN_MEDIA` Hand the visitor one piece of uploaded media, opened in their browser (exit step): a PDF, an image (PNG, JPEG, WebP, SVG) or an MP4 video. The visitor is sent straight to the media, with no page of its own. Any media of the library can be opened: it is uploaded once and referenced by its mediaId; swapping it means pointing the step at another media item, and the QR code never changes.
* `EVENT_ACTION_LOCATION_REQUEST` Ask the visitor for their precise location (GPS) through the browser, with their permission (composite: two branches, "location" when it was shared, "else" when it was refused, skipped or is unavailable).
* `EVENT_ACTION_LANGUAGE_CONDITION` Route visitors based on their phone or browser language (the first language it sends, matched on its two-letter ISO 639-1 base, so "fr" catches fr-FR and fr-CA)
* `EVENT_ACTION_CHAT_BOT` A conversation with one of the workspace's agents that collects visitor attributes (composite: two branches, "completed" when every required objective is known, "else" otherwise)
* `EVENT_ACTION_TRAFFIC_SPLIT` Split visitors between 2 to 20 variants by percentage, for an A/B test (composite: one branch per variant, no "else"). Assignment is deterministic and sticky per device by default. See TrafficSplitPayload.

`id` string

Optional ID for the workflow step (UUID; if not provided, will be generated by backend)

`insertBefore` string

Inserts the new step in front of this one: every branch that led to it now leads to the new step, and the new step's "next" branch leads on to it. Saves creating and then connecting each side by hand. A step with no "next" branch, such as a condition or a multi-link, takes over those branches but leads nowhere until its own branches are connected.

`payload` object

The payload for the workflow step (structure varies by event action)

26 child attributes, the same as [payload in the workflow step object](#workflow-steps-object-payload).

### Response

200

`workflowStep` object

One step of a link's workflow, the path a visitor follows after a scan. Defines what happens (a redirect, a gate, a form...) and which steps it connects to.

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "attributeCapture": {
    "enabled": true,
    "writes": [
      {
        "key": "looking_for",
        "mode": "ATTRIBUTE_WRITE_MODE_SET",
        "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
        "value": "{{choice.label}}"
      }
    ]
  },
  "backButton": {
    "enabled": true,
    "label": "Back to menu"
  },
  "canvasPosition": {
    "x": 320,
    "y": 180
  },
  "eventAction": "EVENT_ACTION_FORM_SUBMIT",
  "id": "987fcdeb-a321-45e6-b789-123456789012",
  "insertBefore": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
  "payload": {
    "chatBot": {
      "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "maxExchanges": 15,
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "objectives": [
        {
          "explanation": "The company the visitor works for. A freelancer can answer their own name.",
          "key": "company",
          "label": "Company",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL"
        }
      ],
      "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
      "skipEnabled": true,
      "skipLabel": "Skip to the menu",
      "skipWhenKnown": true
    },
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "countryCondition": {
      "countries": [
        {
          "countryCode": "US",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ],
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
    },
    "dayOfMonthCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "dayOfMonth": 1,
          "id": "option-1",
          "name": "First of Month",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "dayOfWeekCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "daysOfWeek": [
            1,
            2,
            3,
            4,
            5
          ],
          "id": "option-1",
          "name": "Weekdays",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "deviceActorCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Bots",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
        }
      ]
    },
    "deviceBrandCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Apple Devices",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
        }
      ]
    },
    "deviceBrowserCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "minAppVersion": "400",
          "name": "Chrome Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
        }
      ]
    },
    "devicePlatformCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "iOS Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
        }
      ]
    },
    "deviceTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Desktop Users",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
        }
      ]
    },
    "form": {
      "autoSkipIfKnown": true,
      "formDescription": "Leave your email and we'\''ll send tonight'\''s specials along with the menu.",
      "formFields": [
        {
          "defaultValue": "jules.martin@example.com",
          "helpText": "We send tonight'\''s specials with the menu.",
          "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
          "key": "$email",
          "label": "Email",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "order": 1,
          "placeholder": "jules.martin@example.com",
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL",
          "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
        }
      ],
      "formTitle": "Get the spring menu",
      "skipButtonText": "Skip for now",
      "skipForm": true,
      "submitButtonText": "Show me the menu"
    },
    "languageCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "languages": [
        {
          "languageCode": "fr",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "linkVisit": {},
    "locationRequest": {
      "askOnce": true,
      "buttonLabel": "Share my location",
      "description": "We use it to show you the nearest store.",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "skipEnabled": true,
      "skipLabel": "Not now",
      "title": "Share your location"
    },
    "messagePage": {
      "buttonLabel": "See the menu",
      "description": "Our spring menu is served on the terrace from noon to 10 pm.",
      "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
      "timerSeconds": 5,
      "title": "Welcome to Hotel Lumiere"
    },
    "multiLink": {
      "buttons": [
        {
          "id": "btn-1",
          "label": "Continue to Website",
          "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "order": 1
        }
      ],
      "description": "Select one of the options below to continue",
      "title": "Choose your destination"
    },
    "openMedia": {
      "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
    },
    "password": {
      "description": "Enter the code your server gave you.",
      "password": "lumiere2026",
      "title": "Chef'\''s tasting menu"
    },
    "socialLinks": {
      "description": "Follow us on your favorite platform",
      "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
      "links": [
        {
          "id": "link-1",
          "order": 1,
          "platform": "instagram",
          "url": "https://instagram.com/username"
        }
      ],
      "title": "Connect with us"
    },
    "specificDateCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "day": 25,
          "id": "option-1",
          "month": 12,
          "name": "Christmas",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "year": 2024
        }
      ]
    },
    "thankYouPage": {
      "description": "The spring menu is on its way to your inbox.",
      "title": "Merci, see you at the table!"
    },
    "timeOfDayCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "ranges": [
        {
          "endTime": "17:00",
          "id": "range-1",
          "name": "Business Hours",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "startTime": "09:00"
        }
      ]
    },
    "trafficSplit": {
      "sticky": true,
      "variants": [
        {
          "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
          "label": "Short form",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "weight": 50
        }
      ]
    },
    "vcard": {
      "buttonLabel": "Add to contacts",
      "city": "San Francisco",
      "country": "United States",
      "email": "hello@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "organization": "Acme Corporation",
      "phone": "+33123456789",
      "phoneIsWhatsapp": true,
      "phoneSmsEnabled": true,
      "postalCode": "94102",
      "saveButtonEnabled": true,
      "socialLinks": [
        {
          "platform": "linkedin",
          "url": "https://linkedin.com/in/janedoe"
        }
      ],
      "state": "CA",
      "streetAddress": "123 Main Street",
      "title": "Software Engineer",
      "walletPassEnabled": true,
      "website": "https://acme.com"
    },
    "visitTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "FIRST"
        }
      ]
    },
    "visitorDataCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "attributeKey": "age",
          "comparisonValue": "18",
          "id": "option-1",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "operator": "NUMBER_GREATER_THAN"
        }
      ]
    }
  }
}'
```

Response 200

```json
{
  "workflowStep": {
    "attributeCapture": {
      "enabled": true,
      "writes": [
        {
          "key": "looking_for",
          "mode": "ATTRIBUTE_WRITE_MODE_SET",
          "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
          "value": "{{choice.label}}"
        }
      ]
    },
    "backButton": {
      "enabled": true,
      "label": "Back to menu"
    },
    "backButtonAvailable": true,
    "branches": [
      {
        "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
        "label": "Short form",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      }
    ],
    "canvasPosition": {
      "x": 320,
      "y": 180
    },
    "childStepIds": [
      "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    ],
    "createdAt": "2026-03-14T09:30:00Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "987fcdeb-a321-45e6-b789-123456789012",
    "kind": "KIND_INTERACTION",
    "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "nextCanGoBack": true,
    "nodeType": "NODE_TYPE_COMPOSITE",
    "parentStepIds": [
      "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
    ],
    "payload": {
      "chatBot": {
        "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "maxExchanges": 15,
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "objectives": [
          {
            "explanation": "The company the visitor works for. A freelancer can answer their own name.",
            "key": "company",
            "label": "Company",
            "options": [],
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL"
          }
        ],
        "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
        "skipEnabled": true,
        "skipLabel": "Skip to the menu",
        "skipWhenKnown": true
      },
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "countryCondition": {
        "countries": [
          {
            "countryCode": "US",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ],
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
      },
      "dayOfMonthCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "dayOfMonth": 1,
            "id": "option-1",
            "name": "First of Month",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "dayOfWeekCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "daysOfWeek": [
              1,
              2,
              3,
              4,
              5
            ],
            "id": "option-1",
            "name": "Weekdays",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "deviceActorCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Bots",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
          }
        ]
      },
      "deviceBrandCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Apple Devices",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
          }
        ]
      },
      "deviceBrowserCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "minAppVersion": "400",
            "name": "Chrome Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
          }
        ]
      },
      "devicePlatformCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "iOS Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
          }
        ]
      },
      "deviceTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Desktop Users",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
          }
        ]
      },
      "form": {
        "autoSkipIfKnown": true,
        "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
        "formFields": [
          {
            "defaultValue": "jules.martin@example.com",
            "helpText": "We send tonight's specials with the menu.",
            "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
            "key": "$email",
            "label": "Email",
            "options": [],
            "order": 1,
            "placeholder": "jules.martin@example.com",
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL",
            "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
          }
        ],
        "formTitle": "Get the spring menu",
        "skipButtonText": "Skip for now",
        "skipForm": true,
        "submitButtonText": "Show me the menu"
      },
      "languageCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "languages": [
          {
            "languageCode": "fr",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "linkVisit": {},
      "locationRequest": {
        "askOnce": true,
        "buttonLabel": "Share my location",
        "description": "We use it to show you the nearest store.",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "skipEnabled": true,
        "skipLabel": "Not now",
        "title": "Share your location"
      },
      "messagePage": {
        "buttonLabel": "See the menu",
        "description": "Our spring menu is served on the terrace from noon to 10 pm.",
        "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
        "timerSeconds": 5,
        "title": "Welcome to Hotel Lumiere"
      },
      "multiLink": {
        "buttons": [
          {
            "id": "btn-1",
            "label": "Continue to Website",
            "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
            "order": 1
          }
        ],
        "description": "Select one of the options below to continue",
        "title": "Choose your destination"
      },
      "openMedia": {
        "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
      },
      "password": {
        "description": "Enter the code your server gave you.",
        "password": "lumiere2026",
        "title": "Chef's tasting menu"
      },
      "socialLinks": {
        "description": "Follow us on your favorite platform",
        "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
        "links": [
          {
            "id": "link-1",
            "order": 1,
            "platform": "instagram",
            "url": "https://instagram.com/username"
          }
        ],
        "title": "Connect with us"
      },
      "specificDateCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "day": 25,
            "id": "option-1",
            "month": 12,
            "name": "Christmas",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "year": 2024
          }
        ]
      },
      "thankYouPage": {
        "description": "The spring menu is on its way to your inbox.",
        "title": "Merci, see you at the table!"
      },
      "timeOfDayCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "ranges": [
          {
            "endTime": "17:00",
            "id": "range-1",
            "name": "Business Hours",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "startTime": "09:00"
          }
        ]
      },
      "trafficSplit": {
        "sticky": true,
        "variants": [
          {
            "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
            "label": "Short form",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "weight": 50
          }
        ]
      },
      "vcard": {
        "buttonLabel": "Add to contacts",
        "city": "San Francisco",
        "country": "United States",
        "email": "hello@acme.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "organization": "Acme Corporation",
        "phone": "+33123456789",
        "phoneIsWhatsapp": true,
        "phoneSmsEnabled": true,
        "postalCode": "94102",
        "saveButtonEnabled": true,
        "socialLinks": [
          {
            "platform": "linkedin",
            "url": "https://linkedin.com/in/janedoe"
          }
        ],
        "state": "CA",
        "streetAddress": "123 Main Street",
        "title": "Software Engineer",
        "walletPassEnabled": true,
        "website": "https://acme.com"
      },
      "visitTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "FIRST"
          }
        ]
      },
      "visitorDataCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "attributeKey": "age",
            "comparisonValue": "18",
            "id": "option-1",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "operator": "NUMBER_GREATER_THAN"
          }
        ]
      }
    },
    "rendersPage": true,
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`linkId` string 

path

Required

`stepId` string 

path

Required

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

An empty JSON object.

### Response

200

`stepsRepositioned` integer (int32)

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{stepId}/resolve-collisions" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json"
```

Response 200

```json
{
  "stepsRepositioned": 2
}
```

### Parameters

`linkId` string 

path

Required

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

An empty JSON object.

### Response

200

`stepsRepositioned` integer (int32)

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/auto-layout" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json"
```

Response 200

```json
{
  "stepsRepositioned": 3
}
```

### Parameters

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`branches` array of object

Where branches of the step lead on every link. A branch not listed keeps going to the step the new one was inserted in front of.

2 child attributes

`branchId` string 

Required

The branch: the option's id, the country code on a country condition, the language code on a language condition, the variant id on a traffic split, or "else" for everyone else.

`destination` string 

Required

The URL visitors on this branch go to.

`eventAction` enum 

Required

The step to insert. Conditions and interaction steps only: an exit step would strand what comes after it.

Allowed values

* `EVENT_ACTION_CLIENT_REDIRECT` Redirect visitors to a destination URL
* `EVENT_ACTION_LINK_VISIT` Entry step triggered when the link is visited.
* `EVENT_ACTION_PASSWORD_VERIFY` Require visitors to enter a password before proceeding
* `EVENT_ACTION_FORM_SUBMIT` Present a data collection form to visitors
* `EVENT_ACTION_CONTACT_CARD` Generate a vCard (VCF) response with contact information
* `EVENT_ACTION_MULTI_LINK` A page of buttons where each one continues into more workflow: the button leads to a next step, not straight out. Records which button the visitor pressed, so use it over SOCIAL\_LINKS\_PAGE when that choice is worth measuring or when a branch needs to do more than redirect. This is the menu step: for several documents or PDFs, give each one a button connected to an OPEN\_MEDIA step for media uploaded to the media library, or to a CLIENT\_REDIRECT when the document is already hosted at a URL.
* `EVENT_ACTION_VISIT_TYPE_CONDITION` Route visitors based on whether it's a first or returning visit
* `EVENT_ACTION_COUNTRY_CONDITION` Route visitors based on their country location
* `EVENT_ACTION_DAY_OF_WEEK_CONDITION` Route visitors based on day of week
* `EVENT_ACTION_TIME_OF_DAY_CONDITION` Route visitors based on time of day
* `EVENT_ACTION_DAY_OF_MONTH_CONDITION` Route visitors based on day of month
* `EVENT_ACTION_SPECIFIC_DATE_CONDITION` Route visitors based on specific calendar dates
* `EVENT_ACTION_SOCIAL_LINKS_PAGE` A page of buttons that each leave for an external URL. Social profiles are the common case, not the only one: app stores, docs, booking pages and storefronts all work, and the name is the only thing about it that is social. It is an exit step, so the visitor leaves from here.
* `EVENT_ACTION_DEVICE_TYPE_CONDITION` Route visitors based on device type (e.g. MOBILE, DESKTOP, TABLET)
* `EVENT_ACTION_DEVICE_PLATFORM_CONDITION` Route visitors based on device platform / operating system (e.g. iOS, Android, macOS)
* `EVENT_ACTION_DEVICE_BROWSER_CONDITION` Route visitors based on their browser: a browser family (Chrome, Safari, Firefox...) or the in-app browser of the app a link was opened in (Instagram, TikTok, Facebook, LinkedIn...)
* `EVENT_ACTION_DEVICE_BRAND_CONDITION` Route visitors based on hardware brand (e.g. Apple, Samsung, Google)
* `EVENT_ACTION_DEVICE_ACTOR_CONDITION` Route visitors based on actor classification: HUMAN, BOT, AGENT, AUTOMATED or UNKNOWN. AGENT is an AI agent that names itself (GPTBot, Claude-User, Perplexity-User...). AUTOMATED is a browser driven by software, whoever is behind it: headless Chrome from its request, and a visible browser under automation once a link with the Advanced data collection level has read navigator.webdriver, from that device's next visit on.
* `EVENT_ACTION_VISITOR_DATA_CONDITION` Route visitors based on their profile data or custom attributes
* `EVENT_ACTION_THANK_YOU_PAGE` Display a final thank you / completion message (exit step)
* `EVENT_ACTION_MESSAGE_PAGE` Text with ONE way onward: a single button, or a timer that moves the visitor automatically. It carries no list of destinations, so a page that should offer a choice between two or more places is not this step. Use SOCIAL\_LINKS\_PAGE when the choices leave for external URLs, or MULTI\_LINK when each choice continues into more workflow. Never put links, documents or PDFs on it: it is a message, nothing else.
* `EVENT_ACTION_OPEN_MEDIA` Hand the visitor one piece of uploaded media, opened in their browser (exit step): a PDF, an image (PNG, JPEG, WebP, SVG) or an MP4 video. The visitor is sent straight to the media, with no page of its own. Any media of the library can be opened: it is uploaded once and referenced by its mediaId; swapping it means pointing the step at another media item, and the QR code never changes.
* `EVENT_ACTION_LOCATION_REQUEST` Ask the visitor for their precise location (GPS) through the browser, with their permission (composite: two branches, "location" when it was shared, "else" when it was refused, skipped or is unavailable).
* `EVENT_ACTION_LANGUAGE_CONDITION` Route visitors based on their phone or browser language (the first language it sends, matched on its two-letter ISO 639-1 base, so "fr" catches fr-FR and fr-CA)
* `EVENT_ACTION_CHAT_BOT` A conversation with one of the workspace's agents that collects visitor attributes (composite: two branches, "completed" when every required objective is known, "else" otherwise)
* `EVENT_ACTION_TRAFFIC_SPLIT` Split visitors between 2 to 20 variants by percentage, for an A/B test (composite: one branch per variant, no "else"). Assignment is deterministic and sticky per device by default. See TrafficSplitPayload.

`links` array of string

The links that take the step, each named by id or short link. Up to 50, counting the links named only in overrides.

`overrides` array of object

Links that differ from the shared change.

3 child attributes

`branches` array of object

Replaces the shared entries with the same branchId, for this link.

2 child attributes

`branchId` string 

Required

The branch: the option's id, the country code on a country condition, the language code on a language condition, the variant id on a traffic split, or "else" for everyone else.

`destination` string 

Required

The URL visitors on this branch go to.

`insertBefore` string

Inserts the step in front of this step of the link, instead of right after its entry.

`link` string 

Required

The link, by id or short link.

`payload` object

The step's payload, the same for every link.

26 child attributes, the same as [payload in the workflow step object](#workflow-steps-object-payload).

### Response

200

`failedCount` integer (int32)

`results` array of object

7 child attributes

`errorCode` string

Why it failed, for a failed link.

`errorMessage` string

`issues` array of object

What workflow validation finds on the link now, for a link that succeeded.

4 child attributes

`message` string

`severity` string

"error" or "warning"

`stepId` string

`stepType` string

`link` string

The link as the request named it.

`linkId` string

The link's id. Empty when the name matched no link of this workspace.

`status` enum

How a bulk edit went on one link.

Allowed values

* `BULK_EDIT_STATUS_SUCCEEDED` The change is saved.
* `BULK_EDIT_STATUS_FAILED` It failed: errorCode and errorMessage say why.

`stepId` string

The step inserted, for a link that succeeded.

`succeededCount` integer (int32)

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X POST "https://api.linkbreakers.com/v1/workflow-steps/bulk-insert" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "branches": [
    {
      "branchId": "en",
      "destination": "https://example.com/menu/en"
    }
  ],
  "eventAction": "EVENT_ACTION_LANGUAGE_CONDITION",
  "links": [
    "4BnH-R19p",
    "6e2b7f40-3c1a-4d8e-9b25-7a0f1c3d5e82"
  ],
  "overrides": [
    {
      "branches": [
        {
          "branchId": "en",
          "destination": "https://example.com/menu/en"
        }
      ],
      "insertBefore": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "link": "4BnH-R19p"
    }
  ],
  "payload": {
    "chatBot": {
      "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "maxExchanges": 15,
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "objectives": [
        {
          "explanation": "The company the visitor works for. A freelancer can answer their own name.",
          "key": "company",
          "label": "Company",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL"
        }
      ],
      "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
      "skipEnabled": true,
      "skipLabel": "Skip to the menu",
      "skipWhenKnown": true
    },
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "countryCondition": {
      "countries": [
        {
          "countryCode": "US",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ],
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
    },
    "dayOfMonthCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "dayOfMonth": 1,
          "id": "option-1",
          "name": "First of Month",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "dayOfWeekCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "daysOfWeek": [
            1,
            2,
            3,
            4,
            5
          ],
          "id": "option-1",
          "name": "Weekdays",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "deviceActorCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Bots",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
        }
      ]
    },
    "deviceBrandCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Apple Devices",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
        }
      ]
    },
    "deviceBrowserCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "minAppVersion": "400",
          "name": "Chrome Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
        }
      ]
    },
    "devicePlatformCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "iOS Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
        }
      ]
    },
    "deviceTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Desktop Users",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
        }
      ]
    },
    "form": {
      "autoSkipIfKnown": true,
      "formDescription": "Leave your email and we'\''ll send tonight'\''s specials along with the menu.",
      "formFields": [
        {
          "defaultValue": "jules.martin@example.com",
          "helpText": "We send tonight'\''s specials with the menu.",
          "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
          "key": "$email",
          "label": "Email",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "order": 1,
          "placeholder": "jules.martin@example.com",
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL",
          "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
        }
      ],
      "formTitle": "Get the spring menu",
      "skipButtonText": "Skip for now",
      "skipForm": true,
      "submitButtonText": "Show me the menu"
    },
    "languageCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "languages": [
        {
          "languageCode": "fr",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "linkVisit": {},
    "locationRequest": {
      "askOnce": true,
      "buttonLabel": "Share my location",
      "description": "We use it to show you the nearest store.",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "skipEnabled": true,
      "skipLabel": "Not now",
      "title": "Share your location"
    },
    "messagePage": {
      "buttonLabel": "See the menu",
      "description": "Our spring menu is served on the terrace from noon to 10 pm.",
      "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
      "timerSeconds": 5,
      "title": "Welcome to Hotel Lumiere"
    },
    "multiLink": {
      "buttons": [
        {
          "id": "btn-1",
          "label": "Continue to Website",
          "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "order": 1
        }
      ],
      "description": "Select one of the options below to continue",
      "title": "Choose your destination"
    },
    "openMedia": {
      "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
    },
    "password": {
      "description": "Enter the code your server gave you.",
      "password": "lumiere2026",
      "title": "Chef'\''s tasting menu"
    },
    "socialLinks": {
      "description": "Follow us on your favorite platform",
      "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
      "links": [
        {
          "id": "link-1",
          "order": 1,
          "platform": "instagram",
          "url": "https://instagram.com/username"
        }
      ],
      "title": "Connect with us"
    },
    "specificDateCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "day": 25,
          "id": "option-1",
          "month": 12,
          "name": "Christmas",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "year": 2024
        }
      ]
    },
    "thankYouPage": {
      "description": "The spring menu is on its way to your inbox.",
      "title": "Merci, see you at the table!"
    },
    "timeOfDayCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "ranges": [
        {
          "endTime": "17:00",
          "id": "range-1",
          "name": "Business Hours",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "startTime": "09:00"
        }
      ]
    },
    "trafficSplit": {
      "sticky": true,
      "variants": [
        {
          "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
          "label": "Short form",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "weight": 50
        }
      ]
    },
    "vcard": {
      "buttonLabel": "Add to contacts",
      "city": "San Francisco",
      "country": "United States",
      "email": "hello@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "organization": "Acme Corporation",
      "phone": "+33123456789",
      "phoneIsWhatsapp": true,
      "phoneSmsEnabled": true,
      "postalCode": "94102",
      "saveButtonEnabled": true,
      "socialLinks": [
        {
          "platform": "linkedin",
          "url": "https://linkedin.com/in/janedoe"
        }
      ],
      "state": "CA",
      "streetAddress": "123 Main Street",
      "title": "Software Engineer",
      "walletPassEnabled": true,
      "website": "https://acme.com"
    },
    "visitTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "FIRST"
        }
      ]
    },
    "visitorDataCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "attributeKey": "age",
          "comparisonValue": "18",
          "id": "option-1",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "operator": "NUMBER_GREATER_THAN"
        }
      ]
    }
  }
}'
```

Response 200

```json
{
  "failedCount": 1,
  "results": [
    {
      "errorCode": "BULK_EDIT_LINK_FAILED",
      "errorMessage": "this link could not be changed because of an error on our side: it can be retried",
      "issues": [
        {
          "message": "4c7e1a92 (FORM_SUBMIT) has no outgoing connection — visitors will be stuck here",
          "severity": "error",
          "stepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "stepType": "FORM_SUBMIT"
        }
      ],
      "link": "4BnH-R19p",
      "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
      "status": "BULK_EDIT_STATUS_SUCCEEDED",
      "stepId": "987fcdeb-a321-45e6-b789-123456789012"
    }
  ],
  "succeededCount": 2
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link (UUID)

`stepId` string 

path

Required

The ID of the step the connection leaves from (UUID)

`branchId` string 

path

Required

Which exit of that step to connect. "next" for atomic steps, or a button id, option id, range id, country code, or "else" for composite steps.

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`nextStepId` string

The ID of the step this branch leads to (UUID)

### Response

200

`disconnectedSteps` array of object

Steps that nothing can reach now that this connection changed. Empty means the whole workflow is still connected.

4 child attributes

`message` string

`severity` string

"error" or "warning"

`stepId` string

`stepType` string

`unconnectedBranchIds` array of string

Branches of this step that still lead nowhere, reported without being asked for.

Wiring one branch of a condition and forgetting the rest is the most common way a workflow ships broken: the visitor who takes an unwired branch falls through to the fallback URL. Nothing here is unreachable, so a graph-level check would not catch it — only the step itself knows. Empty means every exit of this step leads somewhere.

`workflowStep` object

The step the connection leaves from, as it now stands

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PUT "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{stepId}/branches/{branchId}/connection" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "nextStepId": "456789ab-cdef-1234-5678-9abcdef01234"
}'
```

Response 200

```json
{
  "disconnectedSteps": [
    {
      "message": "4c7e1a92 (FORM_SUBMIT) has no outgoing connection — visitors will be stuck here",
      "severity": "error",
      "stepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "stepType": "FORM_SUBMIT"
    }
  ],
  "unconnectedBranchIds": [
    "else"
  ],
  "workflowStep": {
    "attributeCapture": {
      "enabled": true,
      "writes": [
        {
          "key": "looking_for",
          "mode": "ATTRIBUTE_WRITE_MODE_SET",
          "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
          "value": "{{choice.label}}"
        }
      ]
    },
    "backButton": {
      "enabled": true,
      "label": "Back to menu"
    },
    "backButtonAvailable": true,
    "branches": [
      {
        "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
        "label": "Short form",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      }
    ],
    "canvasPosition": {
      "x": 320,
      "y": 180
    },
    "childStepIds": [
      "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    ],
    "createdAt": "2026-03-14T09:30:00Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "987fcdeb-a321-45e6-b789-123456789012",
    "kind": "KIND_INTERACTION",
    "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "nextCanGoBack": true,
    "nodeType": "NODE_TYPE_COMPOSITE",
    "parentStepIds": [
      "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
    ],
    "payload": {
      "chatBot": {
        "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "maxExchanges": 15,
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "objectives": [
          {
            "explanation": "The company the visitor works for. A freelancer can answer their own name.",
            "key": "company",
            "label": "Company",
            "options": [],
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL"
          }
        ],
        "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
        "skipEnabled": true,
        "skipLabel": "Skip to the menu",
        "skipWhenKnown": true
      },
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "countryCondition": {
        "countries": [
          {
            "countryCode": "US",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ],
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
      },
      "dayOfMonthCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "dayOfMonth": 1,
            "id": "option-1",
            "name": "First of Month",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "dayOfWeekCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "daysOfWeek": [
              1,
              2,
              3,
              4,
              5
            ],
            "id": "option-1",
            "name": "Weekdays",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "deviceActorCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Bots",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
          }
        ]
      },
      "deviceBrandCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Apple Devices",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
          }
        ]
      },
      "deviceBrowserCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "minAppVersion": "400",
            "name": "Chrome Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
          }
        ]
      },
      "devicePlatformCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "iOS Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
          }
        ]
      },
      "deviceTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Desktop Users",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
          }
        ]
      },
      "form": {
        "autoSkipIfKnown": true,
        "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
        "formFields": [
          {
            "defaultValue": "jules.martin@example.com",
            "helpText": "We send tonight's specials with the menu.",
            "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
            "key": "$email",
            "label": "Email",
            "options": [],
            "order": 1,
            "placeholder": "jules.martin@example.com",
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL",
            "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
          }
        ],
        "formTitle": "Get the spring menu",
        "skipButtonText": "Skip for now",
        "skipForm": true,
        "submitButtonText": "Show me the menu"
      },
      "languageCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "languages": [
          {
            "languageCode": "fr",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "linkVisit": {},
      "locationRequest": {
        "askOnce": true,
        "buttonLabel": "Share my location",
        "description": "We use it to show you the nearest store.",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "skipEnabled": true,
        "skipLabel": "Not now",
        "title": "Share your location"
      },
      "messagePage": {
        "buttonLabel": "See the menu",
        "description": "Our spring menu is served on the terrace from noon to 10 pm.",
        "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
        "timerSeconds": 5,
        "title": "Welcome to Hotel Lumiere"
      },
      "multiLink": {
        "buttons": [
          {
            "id": "btn-1",
            "label": "Continue to Website",
            "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
            "order": 1
          }
        ],
        "description": "Select one of the options below to continue",
        "title": "Choose your destination"
      },
      "openMedia": {
        "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
      },
      "password": {
        "description": "Enter the code your server gave you.",
        "password": "lumiere2026",
        "title": "Chef's tasting menu"
      },
      "socialLinks": {
        "description": "Follow us on your favorite platform",
        "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
        "links": [
          {
            "id": "link-1",
            "order": 1,
            "platform": "instagram",
            "url": "https://instagram.com/username"
          }
        ],
        "title": "Connect with us"
      },
      "specificDateCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "day": 25,
            "id": "option-1",
            "month": 12,
            "name": "Christmas",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "year": 2024
          }
        ]
      },
      "thankYouPage": {
        "description": "The spring menu is on its way to your inbox.",
        "title": "Merci, see you at the table!"
      },
      "timeOfDayCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "ranges": [
          {
            "endTime": "17:00",
            "id": "range-1",
            "name": "Business Hours",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "startTime": "09:00"
          }
        ]
      },
      "trafficSplit": {
        "sticky": true,
        "variants": [
          {
            "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
            "label": "Short form",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "weight": 50
          }
        ]
      },
      "vcard": {
        "buttonLabel": "Add to contacts",
        "city": "San Francisco",
        "country": "United States",
        "email": "hello@acme.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "organization": "Acme Corporation",
        "phone": "+33123456789",
        "phoneIsWhatsapp": true,
        "phoneSmsEnabled": true,
        "postalCode": "94102",
        "saveButtonEnabled": true,
        "socialLinks": [
          {
            "platform": "linkedin",
            "url": "https://linkedin.com/in/janedoe"
          }
        ],
        "state": "CA",
        "streetAddress": "123 Main Street",
        "title": "Software Engineer",
        "walletPassEnabled": true,
        "website": "https://acme.com"
      },
      "visitTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "FIRST"
          }
        ]
      },
      "visitorDataCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "attributeKey": "age",
            "comparisonValue": "18",
            "id": "option-1",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "operator": "NUMBER_GREATER_THAN"
          }
        ]
      }
    },
    "rendersPage": true,
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link (UUID)

`id` string 

path

Required

The ID of the workflow step to update (UUID)

`Idempotency-Key` string 

header

A unique value per request, such as a UUID, that makes retrying it safe: a retry with the same key and body returns the first response instead of acting twice.

### Request body

`attributeCapture` object

Replaces what the step saves to the visitor's profile (optional). Send the whole capture: setting enabled to false keeps the writes you send.

2 child attributes, the same as [attributeCapture in the workflow step object](#workflow-steps-object-attributecapture).

`backButton` object

Replaces the page's back button, which returns the visitor to the previous page (such as the menu) without wiring a connection. Leave it out to keep the current one. Page steps only: MESSAGE\_PAGE, MULTI\_LINK, CONTACT\_CARD, SOCIAL\_LINKS\_PAGE, FORM\_SUBMIT, PASSWORD\_VERIFY and THANK\_YOU\_PAGE. Hidden right after a scan.

2 child attributes

`enabled` boolean

Shows the button. Off keeps the label for when it is switched back on.

`label` string

Text on the button, up to 40 characters. Defaults to "Back".

`canvasPosition` object

The updated canvas position (optional)

2 child attributes

`x` number (double)

X coordinate on the canvas

`y` number (double)

Y coordinate on the canvas

`payload` object

The updated payload for the workflow step (optional)

26 child attributes, the same as [payload in the workflow step object](#workflow-steps-object-payload).

### Response

200

`workflowStep` object

One step of a link's workflow, the path a visitor follows after a scan. Defines what happens (a redirect, a gate, a form...) and which steps it connects to.

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X PATCH "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN" \
  -H "Content-Type: application/json" \
  --data '{
  "attributeCapture": {
    "enabled": true,
    "writes": [
      {
        "key": "looking_for",
        "mode": "ATTRIBUTE_WRITE_MODE_SET",
        "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
        "value": "{{choice.label}}"
      }
    ]
  },
  "backButton": {
    "enabled": true,
    "label": "Back to menu"
  },
  "canvasPosition": {
    "x": 320,
    "y": 180
  },
  "payload": {
    "chatBot": {
      "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "maxExchanges": 15,
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "objectives": [
        {
          "explanation": "The company the visitor works for. A freelancer can answer their own name.",
          "key": "company",
          "label": "Company",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL"
        }
      ],
      "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
      "skipEnabled": true,
      "skipLabel": "Skip to the menu",
      "skipWhenKnown": true
    },
    "clientRedirect": {
      "conversionTracking": true,
      "destination": "https://brand.example.com/checkout"
    },
    "countryCondition": {
      "countries": [
        {
          "countryCode": "US",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ],
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
    },
    "dayOfMonthCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "dayOfMonth": 1,
          "id": "option-1",
          "name": "First of Month",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "dayOfWeekCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "daysOfWeek": [
            1,
            2,
            3,
            4,
            5
          ],
          "id": "option-1",
          "name": "Weekdays",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "deviceActorCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Bots",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
        }
      ]
    },
    "deviceBrandCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Apple Devices",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
        }
      ]
    },
    "deviceBrowserCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "minAppVersion": "400",
          "name": "Chrome Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
        }
      ]
    },
    "devicePlatformCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "iOS Visitors",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
        }
      ]
    },
    "deviceTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "id": "option-1",
          "name": "Desktop Users",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
        }
      ]
    },
    "form": {
      "autoSkipIfKnown": true,
      "formDescription": "Leave your email and we'\''ll send tonight'\''s specials along with the menu.",
      "formFields": [
        {
          "defaultValue": "jules.martin@example.com",
          "helpText": "We send tonight'\''s specials with the menu.",
          "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
          "key": "$email",
          "label": "Email",
          "options": [
            {
              "label": "Terrace",
              "value": "terrace"
            }
          ],
          "order": 1,
          "placeholder": "jules.martin@example.com",
          "required": true,
          "type": "FORM_FIELD_TYPE_EMAIL",
          "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
        }
      ],
      "formTitle": "Get the spring menu",
      "skipButtonText": "Skip for now",
      "skipForm": true,
      "submitButtonText": "Show me the menu"
    },
    "languageCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "languages": [
        {
          "languageCode": "fr",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
        }
      ]
    },
    "linkVisit": {},
    "locationRequest": {
      "askOnce": true,
      "buttonLabel": "Share my location",
      "description": "We use it to show you the nearest store.",
      "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
      "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "skipEnabled": true,
      "skipLabel": "Not now",
      "title": "Share your location"
    },
    "messagePage": {
      "buttonLabel": "See the menu",
      "description": "Our spring menu is served on the terrace from noon to 10 pm.",
      "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
      "timerSeconds": 5,
      "title": "Welcome to Hotel Lumiere"
    },
    "multiLink": {
      "buttons": [
        {
          "id": "btn-1",
          "label": "Continue to Website",
          "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
          "order": 1
        }
      ],
      "description": "Select one of the options below to continue",
      "title": "Choose your destination"
    },
    "openMedia": {
      "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
    },
    "password": {
      "description": "Enter the code your server gave you.",
      "password": "lumiere2026",
      "title": "Chef'\''s tasting menu"
    },
    "socialLinks": {
      "description": "Follow us on your favorite platform",
      "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
      "links": [
        {
          "id": "link-1",
          "order": 1,
          "platform": "instagram",
          "url": "https://instagram.com/username"
        }
      ],
      "title": "Connect with us"
    },
    "specificDateCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "day": 25,
          "id": "option-1",
          "month": 12,
          "name": "Christmas",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "year": 2024
        }
      ]
    },
    "thankYouPage": {
      "description": "The spring menu is on its way to your inbox.",
      "title": "Merci, see you at the table!"
    },
    "timeOfDayCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "ranges": [
        {
          "endTime": "17:00",
          "id": "range-1",
          "name": "Business Hours",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "startTime": "09:00"
        }
      ]
    },
    "trafficSplit": {
      "sticky": true,
      "variants": [
        {
          "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
          "label": "Short form",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "weight": 50
        }
      ]
    },
    "vcard": {
      "buttonLabel": "Add to contacts",
      "city": "San Francisco",
      "country": "United States",
      "email": "hello@acme.com",
      "firstName": "Jane",
      "lastName": "Doe",
      "organization": "Acme Corporation",
      "phone": "+33123456789",
      "phoneIsWhatsapp": true,
      "phoneSmsEnabled": true,
      "postalCode": "94102",
      "saveButtonEnabled": true,
      "socialLinks": [
        {
          "platform": "linkedin",
          "url": "https://linkedin.com/in/janedoe"
        }
      ],
      "state": "CA",
      "streetAddress": "123 Main Street",
      "title": "Software Engineer",
      "walletPassEnabled": true,
      "website": "https://acme.com"
    },
    "visitTypeCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "value": "FIRST"
        }
      ]
    },
    "visitorDataCondition": {
      "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
      "options": [
        {
          "attributeKey": "age",
          "comparisonValue": "18",
          "id": "option-1",
          "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
          "operator": "NUMBER_GREATER_THAN"
        }
      ]
    }
  }
}'
```

Response 200

```json
{
  "workflowStep": {
    "attributeCapture": {
      "enabled": true,
      "writes": [
        {
          "key": "looking_for",
          "mode": "ATTRIBUTE_WRITE_MODE_SET",
          "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
          "value": "{{choice.label}}"
        }
      ]
    },
    "backButton": {
      "enabled": true,
      "label": "Back to menu"
    },
    "backButtonAvailable": true,
    "branches": [
      {
        "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
        "label": "Short form",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      }
    ],
    "canvasPosition": {
      "x": 320,
      "y": 180
    },
    "childStepIds": [
      "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    ],
    "createdAt": "2026-03-14T09:30:00Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "987fcdeb-a321-45e6-b789-123456789012",
    "kind": "KIND_INTERACTION",
    "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "nextCanGoBack": true,
    "nodeType": "NODE_TYPE_COMPOSITE",
    "parentStepIds": [
      "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
    ],
    "payload": {
      "chatBot": {
        "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "maxExchanges": 15,
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "objectives": [
          {
            "explanation": "The company the visitor works for. A freelancer can answer their own name.",
            "key": "company",
            "label": "Company",
            "options": [],
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL"
          }
        ],
        "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
        "skipEnabled": true,
        "skipLabel": "Skip to the menu",
        "skipWhenKnown": true
      },
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "countryCondition": {
        "countries": [
          {
            "countryCode": "US",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ],
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
      },
      "dayOfMonthCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "dayOfMonth": 1,
            "id": "option-1",
            "name": "First of Month",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "dayOfWeekCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "daysOfWeek": [
              1,
              2,
              3,
              4,
              5
            ],
            "id": "option-1",
            "name": "Weekdays",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "deviceActorCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Bots",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
          }
        ]
      },
      "deviceBrandCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Apple Devices",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
          }
        ]
      },
      "deviceBrowserCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "minAppVersion": "400",
            "name": "Chrome Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
          }
        ]
      },
      "devicePlatformCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "iOS Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
          }
        ]
      },
      "deviceTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Desktop Users",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
          }
        ]
      },
      "form": {
        "autoSkipIfKnown": true,
        "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
        "formFields": [
          {
            "defaultValue": "jules.martin@example.com",
            "helpText": "We send tonight's specials with the menu.",
            "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
            "key": "$email",
            "label": "Email",
            "options": [],
            "order": 1,
            "placeholder": "jules.martin@example.com",
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL",
            "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
          }
        ],
        "formTitle": "Get the spring menu",
        "skipButtonText": "Skip for now",
        "skipForm": true,
        "submitButtonText": "Show me the menu"
      },
      "languageCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "languages": [
          {
            "languageCode": "fr",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "linkVisit": {},
      "locationRequest": {
        "askOnce": true,
        "buttonLabel": "Share my location",
        "description": "We use it to show you the nearest store.",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "skipEnabled": true,
        "skipLabel": "Not now",
        "title": "Share your location"
      },
      "messagePage": {
        "buttonLabel": "See the menu",
        "description": "Our spring menu is served on the terrace from noon to 10 pm.",
        "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
        "timerSeconds": 5,
        "title": "Welcome to Hotel Lumiere"
      },
      "multiLink": {
        "buttons": [
          {
            "id": "btn-1",
            "label": "Continue to Website",
            "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
            "order": 1
          }
        ],
        "description": "Select one of the options below to continue",
        "title": "Choose your destination"
      },
      "openMedia": {
        "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
      },
      "password": {
        "description": "Enter the code your server gave you.",
        "password": "lumiere2026",
        "title": "Chef's tasting menu"
      },
      "socialLinks": {
        "description": "Follow us on your favorite platform",
        "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
        "links": [
          {
            "id": "link-1",
            "order": 1,
            "platform": "instagram",
            "url": "https://instagram.com/username"
          }
        ],
        "title": "Connect with us"
      },
      "specificDateCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "day": 25,
            "id": "option-1",
            "month": 12,
            "name": "Christmas",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "year": 2024
          }
        ]
      },
      "thankYouPage": {
        "description": "The spring menu is on its way to your inbox.",
        "title": "Merci, see you at the table!"
      },
      "timeOfDayCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "ranges": [
          {
            "endTime": "17:00",
            "id": "range-1",
            "name": "Business Hours",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "startTime": "09:00"
          }
        ]
      },
      "trafficSplit": {
        "sticky": true,
        "variants": [
          {
            "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
            "label": "Short form",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "weight": 50
          }
        ]
      },
      "vcard": {
        "buttonLabel": "Add to contacts",
        "city": "San Francisco",
        "country": "United States",
        "email": "hello@acme.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "organization": "Acme Corporation",
        "phone": "+33123456789",
        "phoneIsWhatsapp": true,
        "phoneSmsEnabled": true,
        "postalCode": "94102",
        "saveButtonEnabled": true,
        "socialLinks": [
          {
            "platform": "linkedin",
            "url": "https://linkedin.com/in/janedoe"
          }
        ],
        "state": "CA",
        "streetAddress": "123 Main Street",
        "title": "Software Engineer",
        "walletPassEnabled": true,
        "website": "https://acme.com"
      },
      "visitTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "FIRST"
          }
        ]
      },
      "visitorDataCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "attributeKey": "age",
            "comparisonValue": "18",
            "id": "option-1",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "operator": "NUMBER_GREATER_THAN"
          }
        ]
      }
    },
    "rendersPage": true,
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

### Parameters

`linkId` string 

path

Required

The ID of the link (UUID)

`id` string 

path

Required

The ID of the workflow step to delete (UUID)

### Response

200

An empty JSON object.

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{id}" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

### Parameters

`linkId` string 

path

Required

The ID of the link (UUID)

`stepId` string 

path

Required

The ID of the step the connection leaves from (UUID)

`branchId` string 

path

Required

Which exit of that step to clear. "next" for atomic steps, or a button id, option id, range id, country code, or "else" for composite steps.

### Response

200

`disconnectedSteps` array of object

Steps that nothing can reach now that this connection was cleared

4 child attributes

`message` string

`severity` string

"error" or "warning"

`stepId` string

`stepType` string

`unconnectedBranchIds` array of string

Branches of this step that lead nowhere, including the one just cleared

`workflowStep` object

The step the connection left from, as it now stands

Fields: [The workflow step object](#workflow-steps-object).

Errors answer 4xx or 5xx with the [error object](https://linkbreakers.com/help/api#errors), and `429` past the [rate limit](https://linkbreakers.com/help/api#rate-limits).

Request

```bash
curl -X DELETE "https://api.linkbreakers.com/v1/links/{linkId}/workflow-steps/{stepId}/branches/{branchId}/connection" \
  -H "Authorization: Bearer $LINKBREAKERS_TOKEN"
```

Response 200

```json
{
  "disconnectedSteps": [
    {
      "message": "4c7e1a92 (FORM_SUBMIT) has no outgoing connection — visitors will be stuck here",
      "severity": "error",
      "stepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
      "stepType": "FORM_SUBMIT"
    }
  ],
  "unconnectedBranchIds": [
    "else"
  ],
  "workflowStep": {
    "attributeCapture": {
      "enabled": true,
      "writes": [
        {
          "key": "looking_for",
          "mode": "ATTRIBUTE_WRITE_MODE_SET",
          "type": "VISITOR_ATTRIBUTE_TYPE_ENUM",
          "value": "{{choice.label}}"
        }
      ]
    },
    "backButton": {
      "enabled": true,
      "label": "Back to menu"
    },
    "backButtonAvailable": true,
    "branches": [
      {
        "branchId": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
        "label": "Short form",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
      }
    ],
    "canvasPosition": {
      "x": 320,
      "y": 180
    },
    "childStepIds": [
      "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
    ],
    "createdAt": "2026-03-14T09:30:00Z",
    "eventAction": "EVENT_ACTION_CLIENT_REDIRECT",
    "id": "987fcdeb-a321-45e6-b789-123456789012",
    "kind": "KIND_INTERACTION",
    "linkId": "1b9d6bcd-bbfd-4b2d-9b5d-ab8dfbbd4bed",
    "nextCanGoBack": true,
    "nodeType": "NODE_TYPE_COMPOSITE",
    "parentStepIds": [
      "c6f0a3d9-1e7b-4c52-8f4a-9b2d6e0c1f83"
    ],
    "payload": {
      "chatBot": {
        "agentId": "3f9a1c52-8d1e-4b7a-9c3e-2a6f5d8b1e40",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "maxExchanges": 15,
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "objectives": [
          {
            "explanation": "The company the visitor works for. A freelancer can answer their own name.",
            "key": "company",
            "label": "Company",
            "options": [],
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL"
          }
        ],
        "openingMessage": "Bonjour! One quick question and the spring menu is yours.",
        "skipEnabled": true,
        "skipLabel": "Skip to the menu",
        "skipWhenKnown": true
      },
      "clientRedirect": {
        "conversionTracking": true,
        "destination": "https://brand.example.com/checkout"
      },
      "countryCondition": {
        "countries": [
          {
            "countryCode": "US",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ],
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012"
      },
      "dayOfMonthCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "dayOfMonth": 1,
            "id": "option-1",
            "name": "First of Month",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "dayOfWeekCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "daysOfWeek": [
              1,
              2,
              3,
              4,
              5
            ],
            "id": "option-1",
            "name": "Weekdays",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "deviceActorCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Bots",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_ACTOR_CONDITION_VALUE_BOT"
          }
        ]
      },
      "deviceBrandCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Apple Devices",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BRAND_CONDITION_VALUE_APPLE"
          }
        ]
      },
      "deviceBrowserCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "minAppVersion": "400",
            "name": "Chrome Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_BROWSER_CONDITION_VALUE_CHROME"
          }
        ]
      },
      "devicePlatformCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "iOS Visitors",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_PLATFORM_CONDITION_VALUE_IOS"
          }
        ]
      },
      "deviceTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "id": "option-1",
            "name": "Desktop Users",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "DEVICE_TYPE_CONDITION_VALUE_DESKTOP"
          }
        ]
      },
      "form": {
        "autoSkipIfKnown": true,
        "formDescription": "Leave your email and we'll send tonight's specials along with the menu.",
        "formFields": [
          {
            "defaultValue": "jules.martin@example.com",
            "helpText": "We send tonight's specials with the menu.",
            "id": "3f0d2b23-9f51-4d56-84d7-5d9d70fb49c2",
            "key": "$email",
            "label": "Email",
            "options": [],
            "order": 1,
            "placeholder": "jules.martin@example.com",
            "required": true,
            "type": "FORM_FIELD_TYPE_EMAIL",
            "validationPattern": "^[^@\\s]+@[^@\\s]+\\.[a-z]{2,}$"
          }
        ],
        "formTitle": "Get the spring menu",
        "skipButtonText": "Skip for now",
        "skipForm": true,
        "submitButtonText": "Show me the menu"
      },
      "languageCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "languages": [
          {
            "languageCode": "fr",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35"
          }
        ]
      },
      "linkVisit": {},
      "locationRequest": {
        "askOnce": true,
        "buttonLabel": "Share my location",
        "description": "We use it to show you the nearest store.",
        "elseNextStepId": "b2e8f4a1-7c3d-4e9b-a6f2-1d5c8e0b3a74",
        "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
        "skipEnabled": true,
        "skipLabel": "Not now",
        "title": "Share your location"
      },
      "messagePage": {
        "buttonLabel": "See the menu",
        "description": "Our spring menu is served on the terrace from noon to 10 pm.",
        "navigationType": "MESSAGE_PAGE_NAVIGATION_TYPE_BUTTON",
        "timerSeconds": 5,
        "title": "Welcome to Hotel Lumiere"
      },
      "multiLink": {
        "buttons": [
          {
            "id": "btn-1",
            "label": "Continue to Website",
            "nextStepId": "987fcdeb-a321-45e6-b789-123456789012",
            "order": 1
          }
        ],
        "description": "Select one of the options below to continue",
        "title": "Choose your destination"
      },
      "openMedia": {
        "mediaId": "5f1c2d3e-4b5a-6c7d-8e9f-0a1b2c3d4e5f"
      },
      "password": {
        "description": "Enter the code your server gave you.",
        "password": "lumiere2026",
        "title": "Chef's tasting menu"
      },
      "socialLinks": {
        "description": "Follow us on your favorite platform",
        "displayStyle": "SOCIAL_LINKS_DISPLAY_STYLE_DETAILED",
        "links": [
          {
            "id": "link-1",
            "order": 1,
            "platform": "instagram",
            "url": "https://instagram.com/username"
          }
        ],
        "title": "Connect with us"
      },
      "specificDateCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "day": 25,
            "id": "option-1",
            "month": 12,
            "name": "Christmas",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "year": 2024
          }
        ]
      },
      "thankYouPage": {
        "description": "The spring menu is on its way to your inbox.",
        "title": "Merci, see you at the table!"
      },
      "timeOfDayCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "ranges": [
          {
            "endTime": "17:00",
            "id": "range-1",
            "name": "Business Hours",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "startTime": "09:00"
          }
        ]
      },
      "trafficSplit": {
        "sticky": true,
        "variants": [
          {
            "id": "a3f1c6d8-2e4b-4a7c-9d1f-6b8e0c2a4f57",
            "label": "Short form",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "weight": 50
          }
        ]
      },
      "vcard": {
        "buttonLabel": "Add to contacts",
        "city": "San Francisco",
        "country": "United States",
        "email": "hello@acme.com",
        "firstName": "Jane",
        "lastName": "Doe",
        "organization": "Acme Corporation",
        "phone": "+33123456789",
        "phoneIsWhatsapp": true,
        "phoneSmsEnabled": true,
        "postalCode": "94102",
        "saveButtonEnabled": true,
        "socialLinks": [
          {
            "platform": "linkedin",
            "url": "https://linkedin.com/in/janedoe"
          }
        ],
        "state": "CA",
        "streetAddress": "123 Main Street",
        "title": "Software Engineer",
        "walletPassEnabled": true,
        "website": "https://acme.com"
      },
      "visitTypeCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "value": "FIRST"
          }
        ]
      },
      "visitorDataCondition": {
        "elseNextStepId": "987fcdeb-a321-45e6-b789-123456789012",
        "options": [
          {
            "attributeKey": "age",
            "comparisonValue": "18",
            "id": "option-1",
            "nextStepId": "4c7e1a92-5b3d-4f60-8a1e-2d9c6b0f7e35",
            "operator": "NUMBER_GREATER_THAN"
          }
        ]
      }
    },
    "rendersPage": true,
    "updatedAt": "2026-03-18T16:05:00Z"
  }
}
```

---

Source: https://linkbreakers.com/help/api/workflow-steps
