API reference

Routing forms

11 operations.

GET /v1/routing-forms

The account's routing forms, by name, each with its questions and rules.

Operation id
listRoutingForms
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.read
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
archived query string no Values: true , false .

Answers

200 The routing forms. Archived ones are left out unless archived is true. application/json

Field Type Always sent Notes
routing_forms array of object yes
routing_forms[] object yes
routing_forms[].id string yes
routing_forms[].name string yes
routing_forms[].is_active boolean yes
routing_forms[].fallback_event_type_id string or null yes
routing_forms[].version integer yes
routing_forms[].created_at string yes Limits: format date-time.
routing_forms[].updated_at string yes Limits: format date-time.
routing_forms[].archived_at string or null yes Limits: format date-time.
routing_forms[].questions array of object yes
routing_forms[].questions[] object yes
routing_forms[].questions[].id string yes
routing_forms[].questions[].position integer yes
routing_forms[].questions[].label string yes
routing_forms[].questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
routing_forms[].questions[].required boolean yes
routing_forms[].questions[].options array of string yes
routing_forms[].questions[].allow_other boolean yes
routing_forms[].rules array of object yes
routing_forms[].rules[] object yes
routing_forms[].rules[].id string yes
routing_forms[].rules[].position integer yes
routing_forms[].rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
routing_forms[].rules[].action string yes Values: event_type , owner_lookup , url , message .
routing_forms[].rules[].event_type_id string or null yes
routing_forms[].rules[].lookup_endpoint_id string or null yes
routing_forms[].rules[].url string or null yes
routing_forms[].rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The request is not valid. invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
429 Too many attempts. rate_limited

POST /v1/routing-forms

Adds a routing form with no questions and no rules. It starts switched off; add a fallback event type before switching it on.

Operation id
createRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Retry key
Required: send an Idempotency-Key header.
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
Idempotency-Key header string yes Caller-chosen key for a safe retry. 1 to 255 visible ASCII characters. Limits: pattern ^[\u0020-\u007E]{1,255}$.

Request body application/json, required

Field Type Required Notes
name string yes
fallback_event_type_id string or null no Limits: pattern ^evt_[0-9a-z]{26}$.

Answers

201 The routing form. application/json

  • Header Idempotency-Replayed: true when this answer was built from the receipt of an earlier attempt.
Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
409 The same identifier was already used for a different request. This request is already running. id_conflict , request_in_progress
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

POST /v1/routing-forms/import

Creates a new, switched-off routing form from an export document. It is checked as switching it on would be, and every event type and host group it names must be this account's. It never changes an existing form.

Operation id
importRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Retry key
Required: send an Idempotency-Key header.
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
Idempotency-Key header string yes Caller-chosen key for a safe retry. 1 to 255 visible ASCII characters. Limits: pattern ^[\u0020-\u007E]{1,255}$.

Request body application/json, required

Field Type Required Notes
format_version number yes Values: 1 .
name string yes
fallback_event_type_id string or null yes Limits: pattern ^evt_[0-9a-z]{26}$.
questions array of object yes
questions[] object yes
questions[].key string yes Limits: 1 to 64 characters.
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes Limits: pattern ^evt_[0-9a-z]{26}$.
rules[].lookup_endpoint_id string or null no For owner_lookup: a pick_owner lookup endpoint of this account. Every owner lookup rule of a form names the same one. Limits: pattern ^lkp_[0-9a-z]{26}$.
rules[].url string or null yes
rules[].message_text string or null yes

Answers

201 The routing form. application/json

  • Header Idempotency-Replayed: true when this answer was built from the receipt of an earlier attempt.
Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
409 The same identifier was already used for a different request. This request is already running. id_conflict , request_in_progress
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

GET /v1/routing-forms/{routing_form_id}

One routing form, archived or not, with its questions and rules.

Operation id
getRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.read
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The request is not valid. invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
429 Too many attempts. rate_limited

PATCH /v1/routing-forms/{routing_form_id}

Changes the name, the fallback event type or whether the form is switched on. Send the version you read. A form that is on after the change needs a fallback, and every event type it sends visitors to must be switched on and not archived; otherwise nothing is saved.

Operation id
updateRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Assistant tool
No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Request body application/json, required

Field Type Required Notes
version integer yes Limits: at least 1.
name string no
fallback_event_type_id string or null no Limits: pattern ^evt_[0-9a-z]{26}$.
is_active boolean no

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
409 This was changed by someone else since it was read. version_conflict
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

GET /v1/routing-forms/{routing_form_id}/submissions

One routing form's submissions, newest first: what each visitor answered, where the form sent them, and the booking they made.

Operation id
listRoutingFormSubmissions
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_submissions.read
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.
limit query string no
cursor query string no

Answers

200 One page of submissions. application/json

Field Type Always sent Notes
submissions array of object yes
submissions[] object yes
submissions[].id string yes
submissions[].submitted_at string yes Limits: format date-time.
submissions[].form_version integer yes
submissions[].matched_rule_id string or null yes
submissions[].result one of 3 shapes or null yes
submissions[].result{kind=event_type} object yes Shape 1 of 3, where kind is event_type.
submissions[].result{kind=event_type}.kind string yes Values: event_type .
submissions[].result{kind=event_type}.event_type_id string yes
submissions[].result{kind=url} object yes Shape 2 of 3, where kind is url.
submissions[].result{kind=url}.kind string yes Values: url .
submissions[].result{kind=url}.url string yes
submissions[].result{kind=message} object yes Shape 3 of 3, where kind is message.
submissions[].result{kind=message}.kind string yes Values: message .
submissions[].result{kind=message}.message_text string yes
submissions[].answers array of object or null yes
submissions[].answers[] object yes
submissions[].answers[].question_id string yes
submissions[].answers[].label string yes
submissions[].answers[].answer string or array of string yes
submissions[].visitor_email string or null yes
submissions[].booking_id string or null yes
submissions[].host_id string or null yes
submissions[].lookup_outcome string or null yes What the owner lookup decided: owner (the visitor was sent to that host), no_owner, owner_unavailable (the owner named cannot take a booking now), failed_open (the lookup failed and its endpoint fails open), switched_off (the endpoint is off, nothing was asked). In every case but owner the next rules were judged. Null when no owner lookup rule was reached. Values: owner , no_owner , owner_unavailable , failed_open , switched_off .
next_cursor string or null yes

Refusals

Status Meaning Codes
400 The request is not valid. invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
429 Too many attempts. rate_limited

GET /v1/routing-forms/{routing_form_id}/export

One routing form as a portable document: questions keyed q1, q2 in order, conditions naming those keys, destinations by id.

Operation id
exportRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.read
Assistant tool
No. Not in the first set of tools (decision 0043, point 9).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Answers

200 The export document. application/json

Field Type Always sent Notes
format_version number yes Values: 1 .
name string yes
fallback_event_type_id string or null yes Limits: pattern ^evt_[0-9a-z]{26}$.
questions array of object yes
questions[] object yes
questions[].key string yes Limits: 1 to 64 characters.
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes Limits: pattern ^evt_[0-9a-z]{26}$.
rules[].lookup_endpoint_id string or null no For owner_lookup: a pick_owner lookup endpoint of this account. Every owner lookup rule of a form names the same one. Limits: pattern ^lkp_[0-9a-z]{26}$.
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The request is not valid. invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
429 Too many attempts. rate_limited

POST /v1/routing-forms/{routing_form_id}/archive

Archives a routing form and switches its booking links off. The rows stay.

Operation id
archiveRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Assistant tool
No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Request body application/json, required

Field Type Required Notes
version integer yes Limits: at least 1.

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
409 This was changed by someone else since it was read. version_conflict
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

POST /v1/routing-forms/{routing_form_id}/restore

Brings an archived routing form back. Links that were switched off stay off.

Operation id
restoreRoutingForm
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Assistant tool
No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Request body application/json, required

Field Type Required Notes
version integer yes Limits: at least 1.

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
409 This was changed by someone else since it was read. version_conflict
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

PUT /v1/routing-forms/{routing_form_id}/questions

Replaces the questions. Send the whole ordered list and the version you read. An entry that carries its id keeps that id. A list that would leave a rule naming a question it removes is refused.

Operation id
replaceRoutingFormQuestions
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Assistant tool
No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Request body application/json, required

Field Type Required Notes
version integer yes Limits: at least 1.
questions array of object yes
questions[] object yes
questions[].id string no Limits: pattern ^rtq_[0-9a-z]{26}$.
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean no
questions[].options array of string no
questions[].allow_other boolean no

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
409 This was changed by someone else since it was read. version_conflict
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited

PUT /v1/routing-forms/{routing_form_id}/rules

Replaces the rules. Send the whole list in the order they are tried, and the version you read; the first matching rule wins. An entry that carries its id keeps that id. Every condition is checked, and every event type and host group must be this account's.

Operation id
replaceRoutingFormRules
Who can call it
Acts in one account, the one the credential belongs to.
Credentials
session or API key
Permission
routing_forms.manage
Assistant tool
No. A repeat could take effect twice: it takes no retry key, or its write does not store the key or check a version (decision 0043, point 7).

Parameters

Name In Type Required Notes
routing_form_id path string yes Limits: pattern ^rtf_[0-9a-z]{26}$.

Request body application/json, required

Field Type Required Notes
version integer yes Limits: at least 1.
rules array of object yes
rules[] object yes
rules[].id string no Limits: pattern ^rtr_[0-9a-z]{26}$.
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null no Limits: pattern ^evt_[0-9a-z]{26}$.
rules[].lookup_endpoint_id string or null no For owner_lookup: a pick_owner lookup endpoint of this account. Every owner lookup rule of a form names the same one. Limits: pattern ^lkp_[0-9a-z]{26}$.
rules[].url string or null no
rules[].message_text string or null no

Answers

200 The routing form. application/json

Field Type Always sent Notes
id string yes
name string yes
is_active boolean yes
fallback_event_type_id string or null yes
version integer yes
created_at string yes Limits: format date-time.
updated_at string yes Limits: format date-time.
archived_at string or null yes Limits: format date-time.
questions array of object yes
questions[] object yes
questions[].id string yes
questions[].position integer yes
questions[].label string yes
questions[].kind string yes Values: short_text , long_text , single_choice , multi_choice , dropdown , phone , email , name .
questions[].required boolean yes
questions[].options array of string yes
questions[].allow_other boolean yes
rules array of object yes
rules[] object yes
rules[].id string yes
rules[].position integer yes
rules[].condition any yes A condition tree: a test {question_id, operator, value}, or {all: [...]} or {any: [...]} with at least one condition. At most 3 levels deep and 40 parts. Operators: equals, not_equals, one_of, contains, is_answered, is_not_answered, email_domain_is.
rules[].action string yes Values: event_type , owner_lookup , url , message .
rules[].event_type_id string or null yes
rules[].lookup_endpoint_id string or null yes
rules[].url string or null yes
rules[].message_text string or null yes

Refusals

Status Meaning Codes
400 The body is not valid JSON. The request is not valid. invalid_json , invalid_request
401 Sign in is required. unauthenticated
403 You are not allowed to do that. Choose an account to act in first. forbidden , no_active_account
404 Nothing was found there. not_found
409 This was changed by someone else since it was read. version_conflict
415 Send the body as JSON. unsupported_media_type
429 Too many attempts. rate_limited