Update form

Update an existing form

put

The form ID is provided in the route.

Path parameters

idstringRequired

The ID of the form to update.

Body

application/jsontext/jsonapplication/*+json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

Gets or sets the description associated with the form.

statusstring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the queue has been marked as deleted.

Responses

200

OK

application/json

idstringOptional

namestringOptional

iconstring · nullableOptional

revisioninteger · int32Optional

descriptionstring · nullableOptional

Gets or sets the description associated with the form.

statusstring · enumOptionalPossible values:

isDeletedbooleanOptional

Indicates whether the queue has been marked as deleted.

403

Forbidden

application/json

404

Not Found

application/json

500

Internal Server Error

put/public/v1/helpdesk/forms/{id}

HTTPcURLJavaScriptPython

PUT /public/v1/helpdesk/forms/{id} HTTP/1.1
Host: api.platform.softwareone.com
Content-Type: application/json
Accept: */*
Content-Length: 820

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "description": "text",
  "status": "Unpublished",
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "statistics": {
    "groups": 1,
    "parameters": 1
  },
  "isDeleted": true
}

application/jsontext/jsonapplication/*+json

{
  "id": "text",
  "audit": {
    "created": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "updated": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "deleted": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "published": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    },
    "unpublished": {
      "at": "2026-07-15T20:07:59.861Z",
      "by": {
        "id": "text",
        "name": "text",
        "icon": "text",
        "revision": 1
      }
    }
  },
  "$meta": {
    "omitted": [
      "text"
    ]
  },
  "name": "text",
  "icon": "text",
  "revision": 1,
  "description": "text",
  "status": "Unpublished",
  "account": {
    "id": "text",
    "name": "text",
    "icon": "text",
    "revision": 1,
    "type": "Client",
    "status": "Active"
  },
  "statistics": {
    "groups": 1,
    "parameters": 1
  },
  "isDeleted": true
}