curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.example.com/api/admin/sites/{id}/install/snippet' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"snippet": "string",
"instructions": "Two-person tent, green — replacement for damaged pole set."
}
Generate the install snippet
Body: . Returns .
POST
/
api
/
admin
/
sites
/
{id}
/
install
/
snippet
curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.example.com/api/admin/sites/{id}/install/snippet' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"snippet": "string",
"instructions": "Two-person tent, green — replacement for damaged pole set."
}
Body:
{ platform }. Returns { snippet, instructions }.
Path parameters
Request body
No request body.Response
object
Status codes
| Code | Meaning |
|---|---|
200 | Snippet and instructions |
401 | Error |
404 | Error |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request POST \
--url 'https://api.example.com/api/admin/sites/{id}/install/snippet' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"snippet": "string",
"instructions": "Two-person tent, green — replacement for damaged pole set."
}
Last modified on November 13, 2026