Update a form

PUT/forms/{id}

Authorization

AuthorizationBearer token (JWT) · headerrequired

Path parameters

idstringrequired

Form ID or slug

Request body

requiredapplication/json

titlestring

slugstring

descriptionstring

formatstring

markdown is accepted as input and converted to html before saving.

Allowed:htmlmarkdown

bodystring

visibleboolean

success_messagestring

has_address_fieldsboolean

Responses

200

Form updated

_linksHalLinks

idinteger

shop_idinteger

titlestring

slugstring

bodystring

descriptionstring

visibleboolean

formatstring

has_address_fieldsboolean

success_messagestring

created_onstring<date-time>

updated_onstring<date-time>

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer token (JWT)Remember on this deviceInclude my values in samples

Parameters

idpath*Form ID or slug

Bodyapplication/json

titlestringslugstringdescriptionstringformatstring`markdown` is accepted as input and converted to `html` before saving.bodystringvisiblebooleansuccess_messagestringhas_address_fieldsboolean

Request

curl -X PUT 'https://api.onbolder.com/v2/forms/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "slug": "string",
  "description": "string",
  "format": "html",
  "body": "string",
  "visible": true,
  "success_message": "string",
  "has_address_fields": true
}'

const response = await fetch("https://api.onbolder.com/v2/forms/string", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"string\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"format\": \"html\",\n  \"body\": \"string\",\n  \"visible\": true,\n  \"success_message\": \"string\",\n  \"has_address_fields\": true\n}"
});

import requests

response = requests.put(
    "https://api.onbolder.com/v2/forms/string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"string\",\n  \"slug\": \"string\",\n  \"description\": \"string\",\n  \"format\": \"html\",\n  \"body\": \"string\",\n  \"visible\": true,\n  \"success_message\": \"string\",\n  \"has_address_fields\": true\n}",
)

Response

{
  "_links": {
    "property1": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    },
    "property2": {
      "href": "string",
      "templated": true,
      "method": "get",
      "title": "string",
      "type": "string"
    }
  },
  "id": 0,
  "shop_id": 0,
  "title": "string",
  "slug": "string",
  "body": "string",
  "description": "string",
  "visible": true,
  "format": "string",
  "has_address_fields": true,
  "success_message": "string",
  "created_on": "2019-08-24T14:15:22Z",
  "updated_on": "2019-08-24T14:15:22Z"
}