Skip to content

sitePlanPins

Places module · 5 operations

List site plan pin rows

GET/site-plan-pins

A pin on a site plan. Returns a cursor page of site plan pin rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Create a site plan pin

POST/site-plan-pins

A pin on a site plan. Creates a site plan pin. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Get a site plan pin

GET/site-plan-pins/{id}

A pin on a site plan. Returns one site plan pin with its `ETag`. A site plan pin the caller may not see returns 404.

Update a site plan pin

PATCH/site-plan-pins/{id}

A pin on a site plan. Updates the fields sent; omitted fields are unchanged. Requires `If-Match` with the current `ETag`: a stale tag returns 412 and a missing tag returns 428.

Delete a site plan pin

DELETE/site-plan-pins/{id}

A pin on a site plan. Soft-deletes the site plan pin: it moves to Trash and can be restored for its table's retention period.