Docs
V2 APIConnections

Delete connection

DELETE/api/v2/connections/{connection}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

connection*string
Formatuuid

Query Parameters

account_id?string

Optional account to run this request against. Defaults to the account the API token is scoped to, so callers with a single account can omit it. Must be an account the authenticated user belongs to; staff may target any account. For write requests the value may be sent in the JSON body instead of the query string. The resolved account is returned on the X-Resi-Account-Id response header.

Formatuuid

Response Body

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/api/v2/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08"
Empty

Update connection PATCH

Previous Page

Run connection POST

Queues a run for a runnable, enabled connection. Returns 202 as the work is asynchronous. Most connection types run every attached property and take no body. The internal V1 Import type is the exception: it runs one property at a time, requires `property_id`, and accepts an optional `resources` list. Running a V1 Import connection is restricted to Resi staff.