Run connection
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.
/api/v2/connections/{connection}/runQueues 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.
Authorization
bearerAuth In: header
Path Parameters
uuidQuery Parameters
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.
uuidRequest Body
application/json
Accepted only by the V1 Import connection type; any other type rejects these keys with a 422.
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/run" \ -H "Content-Type: application/json" \ -d '{}'{ "message": "string", "connection_id": "d3547de1-d1f2-4344-b4c2-17169b7526f9", "property_id": "05003a8a-8f3c-454b-8884-a906ec46f5f5", "resources": [ "string" ]}