Move Instance

PATCH 
/api/v2/admin/business/move-instance

This functionality allows administrators to flexibly manage associations of instances with businesses, allowing for reorganization and reallocation according to business needs.

Request

application/json

Body

required

sourceInstanceId Source Instancerequired
businessIdTarget Business Targetrequired

Responses

200

AdminMoveInstanceResponse

application/json

Schema

Schema

businessId stringrequired
name stringrequired
businessToken stringrequired
attributes objectrequired
createdAt date-timerequired
updatedAt date-timerequired
deletedAt date-timerequired
Instance object[]required
Array [
instanceId stringrequired
name stringrequired
state stringrequired
Default value: active | inactive
connection stringrequired
Default value: open | close | refused
createdAt date-timerequired
deletedAt date-timerequired
businessBusinessId stringrequired
Auth object
authId stringrequired
jwt stringrequired
createdAt date-timerequired
updatedAt date-timerequired
]

Example (from schema)

{
  "businessId": "string",
  "name": "string",
  "businessToken": "string",
  "attributes": {},
  "createdAt": "2024-04-14T14:11:05.596Z",
  "updatedAt": "2024-04-14T14:11:05.596Z",
  "deletedAt": "2024-04-14T14:11:05.596Z",
  "Instance": [
    {
      "instanceId": "string",
      "name": "string",
      "state": "active | inactive",
      "connection": "open | close | refused",
      "createdAt": "2024-04-14T14:11:05.597Z",
      "deletedAt": "2024-04-14T14:11:05.597Z",
      "businessBusinessId": "string",
      "Auth": {
        "authId": "string",
        "jwt": "string",
        "createdAt": "2024-04-14T14:11:05.597Z",
        "updatedAt": "2024-04-14T14:11:05.597Z"
      }
    }
  ]
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...