API fields
Document parameters, responses and nested objects.
On this page
These components describe an API endpoint. The examples below use a made-up widgets endpoint to show the components; they do not describe a real Hexel Studio API.
Parameters
Name a parameter with path, query, body or header. The name of the prop becomes the location badge.
widget_idstringpathrequired
The widget to update.
dry_runbooleanquerydefault: false
Validate the request without saving it.
X-Organization-Idstringheaderrequired
The organization that owns the widget.
labelsstring[]bodydeprecated
Use tags instead.
<ParamField path="widget_id" type="string" required>
The widget to update.
</ParamField>
<ParamField query="dry_run" type="boolean" default="false">
Validate the request without saving it.
</ParamField>Responses
idstringrequired
Unique identifier of the widget.
ownerobject
Who created the widget.
<ResponseField name="owner" type="object">
Who created the widget.
<Expandable title="owner properties">
<ResponseField name="id" type="string">Identifier of the account.</ResponseField>
</Expandable>
</ResponseField>Request and response examples
<RequestExample> and <ResponseExample> take code blocks, like <CodeGroup>. Mintlify pins them beside the page; here they render where you place them.
curl --request PATCH \
--url 'https://api.example.com/v1/widgets/wid_123' \
--header 'X-Organization-Id: org_123' \
--data '{"tags": ["beta"]}'{
"id": "wid_123",
"owner": { "id": "usr_456", "kind": "user" }
}