forms

Update a form token

patch/v1/brands/{brandId}/forms/{formId}

Request

  • Base URL: https://api.dispatchtickets.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.dispatchtickets.com/v1/brands/{brandId}/forms/{formId}
  • Auth: HTTP bearer

Path parameters

formIdstring required

Request body

namestring
successUrlstring
errorUrlstring
thankYouMessagestring
fieldMappingobject
honeypotFieldstring
allowedOriginsstring[]
enabledboolean

Example request

{
  "name": "Contact Form",
  "successUrl": "https://example.com/thank-you",
  "errorUrl": "https://example.com/error",
  "thankYouMessage": "Thanks for reaching out! We will get back to you within 24 hours.",
  "fieldMapping": {
    "email": "customFields.requesterEmail"
  },
  "honeypotField": "_gotcha",
  "allowedOrigins": [
    "https://example.com"
  ],
  "enabled": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.