Update a checkout form element

POST 
https://api.tickettailor.com/v1/checkout_forms/:checkout_form_id/elements/:checkout_form_element_id

Updates an existing checkout form element

Request

Path Parameters

checkout_form_id stringrequired

The unique identifier for the checkout form

checkout_form_element_id stringrequired

The unique identifier for the checkout form element

application/x-www-form-urlencoded

Body

optionsstring[]

The list of answers for the checkout form element

questionstring

The question for the checkout form element

per_ticketboolean

Whether the checkout form element is asked globally or per ticket

Example: true

requiredboolean

Whether the checkout form element is required to answer

Example: true

typestring

The type of the checkout form element

Possible values: [multiCheckbox, radio, select]

Responses

200

Successfully updated the checkout form element

application/json

Schema

Schema

objectstring

idstring

A unique identifier for the checkout form element

checkout_form_idstring

A unique identifier for the checkout form

optionsstring[]

List of possible answers for the element

per_ticketstring

Whether the checkout form element is asked globally or per ticket

Possible values: [true, false]

questionstring

The question to be answered

requiredstring

Indicates whether the question is required to answer

Possible values: [true, false]

typestring

The type of the checkout form element

Possible values: [multiCheckbox, radio, select]

Example (auto)

{
  "object": "checkout_form_element",
  "id": "ce_123",
  "checkout_form_id": "cf_123",
  "options": [
    "Yes",
    "No"
  ],
  "per_ticket": "true",
  "question": "Do you have any dietary requirements?",
  "required": "true",
  "type": "radio"
}

default

Error schema

application/json

Schema

Schema

statusintegerrequired
Http status code
error_codestringrequired
Readable error code
messagestringrequired
Detailed error message
errors object[]
Validation errors if POST request was sent. Otherwise not present.
Array [
fieldstring
Field name that failed validation
messagesstring[]
Validation error message
]

Example (auto)

{
  "status": 0,
  "error_code": "string",
  "message": "string",
  "errors": [
    {
      "field": "string",
      "messages": [
        "string"
      ]
    }
  ]
}

Authorization: http

name: BasicAuthtype: httpdescription: Use base64 encoded api key created in Ticket Tailor dashboard.
scheme: basic

• curl
• php
• ruby
• python
• nodejs
• go

• CURL

curl -L -X POST 'https://api.tickettailor.com/v1/checkout_forms/:checkout_form_id/elements/:checkout_form_element_id' \
-H 'Content-Type: application/x-www-form-urlencoded' \
-H 'Accept: application/json' \
-H 'Authorization: Basic PHVzZXJuYW1lPjo8cGFzc3dvcmQ+'

Request Collapse all

Base URL

https://api.tickettailor.com

Auth

Username

Password

Parameters

checkout_form_id — pathrequired

checkout_form_element_id — pathrequired

Body

options

question

per_ticket

required

type

---multiCheckboxradioselect