VRPlatformVRPlatform
Teams

/team

Update the current team (singleton: the team in scope via the x-team-id header). A scoped partner key with partner:provisioning:v1 may set a non-null migratedFromTenantId only when it is the sole request field, the selected target is GL-enabled, and the non-GL source belongs to the same partner; all other partner-key updates require teams:write. status requests the administrative state. Before requesting active, check capabilities.activate; the API rejects activation when subscription or effective billing-partner state prevents the response from becoming active. Send null for logo or colorPrimary to clear that branding value. Changing statementStartAt reclassifies unlocked journals around the first live GL date while explicit opening-balance journals remain active. Reapplying the current date only restores explicit opening-balance journals inactivated by the GL boundary.

Required scope: teams:read

PUT
/team

Authorization

apiKey
X-API-Key<token>

API key provided in dashboard

In: header

Request Body

application/json

defaultCurrency?string|null
longTermStayNights?number|null
defaultRevenueRecognition?string|null
name?string
slug?string
statementAddress?|null
billingAddress?|null
phone?string|null
taxId?string|null
companyName?string|null
type?string
Value in"partner" | "admin" | "propertyManager"
billingSubscriptionStatus?string|null
billingPlan?string|null
cancelledAt?string|null
isOnboarding?boolean|null
isOpex?boolean
booksClosedAt?string|null
logo?string|null

Logo URL or data URI. Send null to clear it.

statementStartAt?string|null
effectiveStatementStartAt?string|null
ownerPortalShowDraftStatements?boolean
partnerId?string|null
billingPartnerId?string|null
email?string
Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
Formatemail
supportEmail?string|null
colorPrimary?string|null

Primary brand color. Send null to clear it.

migratedFromTenantId?string|null
settings?
cancelation?|null

Cancelation or Reinstatement of the team.

status?string

Only status of partner teams can be updated

Value in"active" | "inactive"

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PUT "https://staging.api.vrplatform.app/team" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "uniqueRef": "string",
  "dataRegion": "ap",
  "storageRealm": "vrintegration",
  "defaultCurrency": "string",
  "longTermStayNights": 0,
  "defaultRevenueRecognition": "checkIn",
  "migratedFromTenantId": "cc45f885-c973-4e0e-8e0d-b63cf61a5091",
  "historicalStatementsImportedAt": "2024-01-15T12:30:00.000+00:00",
  "name": "string",
  "slug": "string",
  "statementAddress": {
    "full": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "stateCode": "string",
    "countryCode": "string"
  },
  "billingAddress": {
    "full": "string",
    "line1": "string",
    "line2": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string",
    "stateCode": "string",
    "countryCode": "string"
  },
  "phone": "string",
  "email": "string",
  "supportEmail": "string",
  "taxId": "string",
  "partner": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "billingPartner": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "name": "string"
  },
  "billingPartnerId": "923c9e6a-7971-4599-a964-4e4ec88578c6",
  "companyName": "string",
  "type": "partner",
  "status": "active",
  "capabilities": {
    "activate": {
      "enabled": true,
      "disabledReasons": [
        "teamBillingSubscriptionInactive"
      ]
    }
  },
  "billingSubscriptionStatus": "string",
  "billingPlan": "string",
  "billingPaymentMethodType": "string",
  "billingCustomerId": "string",
  "colorPrimary": "string",
  "createdAt": "2024-01-15T12:30:00.000+00:00",
  "updatedAt": "2024-01-15T12:30:00.000+00:00",
  "cancelledAt": "string",
  "isOnboarding": true,
  "issues": [
    {
      "code": "unassignedAccount",
      "severity": "error",
      "context": {
        "accountIds": [
          "string"
        ]
      }
    }
  ],
  "isGeneralLedger": true,
  "isOpex": true,
  "booksClosedAt": "string",
  "logo": "string",
  "statementStartAt": "string",
  "effectiveStatementStartAt": "string",
  "settings": {
    "showVRPilotGuide": true,
    "showReservations": true,
    "showCancelledReservations": true,
    "showReservationTotal": true,
    "showOwnerCalendarBlocking": true,
    "showTaxStatements": true,
    "showTwoFactorAuth": true
  },
  "ownerPortalShowDraftStatements": true,
  "members": [
    {
      "userId": "string",
      "email": "string",
      "role": "string",
      "name": "string",
      "firstName": "string",
      "lastName": "string"
    }
  ],
  "extractableConnections": {
    "property1": {
      "connections": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "appId": "string",
          "urlExample": "string",
          "allowConfirmationCode": true
        }
      ]
    },
    "property2": {
      "connections": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "appId": "string",
          "urlExample": "string",
          "allowConfirmationCode": true
        }
      ]
    }
  },
  "enabledFeatures": [
    {
      "featureId": "317f79d2-08bf-4d22-9731-b2b5e1f0a085",
      "status": "all"
    }
  ],
  "isBillable": true,
  "aggregates": {
    "activeListings": 9007199254740991,
    "members": 9007199254740991,
    "activeConnections": 9007199254740991,
    "connectionIssues": 9007199254740991,
    "childTeams": 9007199254740991
  }
}
{
  "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
}

/team/settings PUT

Previous Page

/contacts/{id}/viewers/{userId} DELETE

Next Page