V2 APIConnections
Create connection
POST
/api/v2/connectionsAuthorization
bearerAuth AuthorizationBearer <token>
In: header
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.
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v2/connections" \ -H "Content-Type: application/json" \ -d '{ "type": "string", "name": "string" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "type": "string", "category": "string", "name": "string", "enabled": true, "pricing_includes_fees": true, "settings": {}, "properties": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "settings": {} } ], "latest_log": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "event_type": "string", "status": "string", "message": "string", "duration": 0, "created_at": "2019-08-24T14:15:22Z" }, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" }}