Teams
/team/guides/onboarding
Update the current team's onboarding guide state
Required scope: team-onboarding:write
Authorization
apiKey X-API-Key<token>
API key provided in dashboard
In: header
Request Body
application/json
status?string|null
addOwners?string|null
addWorkflows?string|null
connectAiAgents?string|null
connectAirbnb?string|null
connectBankAccounts?string|null
connectPaymentProcessors?string|null
connectPms?string|null
connectRamp?string|null
feesAndCommissions?string|null
openingBalances?string|null
ownerStatementTemplate?string|null
reportingPreferences?string|null
validateAndGoLive?string|null
welcome?string|null
[key: string]?never
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PUT "https://api.vrplatform.app/team/guides/onboarding" \ -H "Content-Type: application/json" \ -d '{}'{
"status": "skipped",
"welcome": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectPms": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectAiAgents": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectBankAccounts": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectRamp": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectPaymentProcessors": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"connectAirbnb": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"addOwners": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"reportingPreferences": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"feesAndCommissions": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"ownerStatementTemplate": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"openingBalances": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"addWorkflows": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
},
"validateAndGoLive": {
"status": "skipped",
"updatedAt": "2024-01-15T12:30:00.000+00:00"
}
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}{
"code": "string",
"message": "string",
"links": {
"docs": "string",
"schema": "string"
},
"issues": [
{
"message": "string",
"path": [
"string"
],
"schema": "string"
}
],
"context": null
}