Skip to main content
PUT
/
v3
/
forms
/
{form_id}
Update an existing form
curl --request PUT \
  --url https://api.ctrl-hub.com/v3/forms/{form_id} \
  --header 'Content-Type: application/vnd.api+json' \
  --header 'X-Session-Token: <api-key>' \
  --data '
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "<string>",
    "attributes": {
      "name": "<string>",
      "description": "<string>",
      "status": "draft"
    },
    "relationships": {
      "categories": {
        "data": [
          {
            "type": "<string>",
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          }
        ]
      }
    }
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "<string>",
  "attributes": {
    "name": "<string>",
    "description": "<string>",
    "status": "draft"
  },
  "meta": {
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "modified_at": "2023-11-07T05:31:56Z",
    "counts": {
      "schemas": 0,
      "categories": 0,
      "submissions": 0,
      "submission_versions": 0
    }
  },
  "relationships": {
    "organisation": {
      "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>"
      }
    },
    "categories": {
      "data": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      ]
    },
    "schemas": {
      "data": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      ]
    },
    "author": {
      "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>"
      }
    },
    "latest_schema": {
      "data": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "type": "<string>"
      }
    },
    "submissions": {
      "data": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>"
        }
      ]
    }
  }
}

Authorizations

X-Session-Token
string
header
required

Session token for authentication.

Path Parameters

form_id
string<uuid>
required

The unique identifier for the form.

Body

application/vnd.api+json

The form to update.

data
object
required

Response

The updated form

A form

id
string<uuid>
required

The unique identifier of the form.

type
string
required
Allowed value: "forms"
attributes
object
required

Attributes for a form

meta
object
required

Metadata for a form

relationships
object
required

Relationships for a form