Connections
/connections/{id}/connect
Reconnect an existing app connection. OAuth defaults to https://portal.vrplatform.app/callback/ when redirectTo is omitted. The legacy production /callback path is normalized to /callback/. The built-in API app preserves its existing server-generated identity. Provider identities owned by another connection are rejected before mutation. PMS reconnections queue durable reservation line-mapping initialization. Hostaway webhook reconciliation runs after credentials are stored. Provider tasks may take up to 25 seconds. Tasks that exceed the limit return ERROR_TIMEOUT.
Required scope: integrations:write
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Path Parameters
id*string
Match
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Format
uuidRequest Body
application/json
appId?string
name?string
autoExtract?boolean
Default
truesessionKey?string
redirectTo?string
Format
uriparams?
Default
{}Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://staging.api.vrplatform.app/connections/497f6eca-6276-4993-bfeb-53cbbbba6f08/connect" \ -H "Content-Type: application/json" \ -d '{}'{
"type": "success",
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"connection": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"status": "active",
"accountingStartAt": "string",
"accountingEndAt": "string",
"uniqueRef": "string",
"app": {
"id": "string",
"type": "paymentGateway",
"name": "string",
"icon": "string",
"importers": [
"string"
],
"extractors": [
"string"
]
},
"createdAt": "2024-01-15T12:30:00.000+00:00",
"updatedAt": "2024-01-15T12:30:00.000+00:00",
"isErrorState": true,
"currentSync": {
"status": "queued",
"createdAt": "2024-01-15T12:30:00.000+00:00",
"updatedAt": "2024-01-15T12:30:00.000+00:00",
"message": "string"
},
"enabledFlows": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"isPublic": true,
"type": "push"
}
]
},
"code": "string",
"message": "string",
"state": {
"sessionKey": "string",
"expiresIn": 0
},
"action": {
"type": "extension",
"value": null
}
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"retryable": true,
"context": null
}