Bulk Enable SaaS

POST 
/saas-api/public-api/bulk-enable-saas/:companyId

deprecated

This endpoint has been deprecated and may be replaced or removed in future versions of the API.

Enable SaaS mode for multiple locations with support for both SaaS v1 and v2

Request

Version stringrequired

API Version

Available options2023-02-21

companyId stringrequired

Company ID to enable SaaS for

application/json

application/json

Body

Bodyrequired

locationIdsstring[]required

Array of location IDs to enable SaaS for

isSaaSV2booleanrequired

Indicates if the SaaS is V2

actionPayloadobjectrequired

Action payload for the bulk enable SaaS operation

Example (auto)

{
  "locationIds": [
    "locationId1",
    "locationId2"
  ],
  "isSaaSV2": true,
  "actionPayload": {
    "priceId": "price_1QDPY5FpU9DlKp7RQ8BXfywx",
    "stripeAccountId": "acct_1QDPY5FpU9DlKp7RQ8BXfywx",
    "saasPlanId": "66c4d36534f21f900dc2a265",
    "providerLocationId": "r06mdj4OrrERzYDvsOdh"
  }
}

application/json

Bulk SaaS enable operation completed successfully

application/json

Schema

Schema

successbooleanrequired

Indicates if the bulk enable SaaS operation was successful

messagestringrequired

Message indicating the bulk enable SaaS operation

bulkActionUrlstring

URL for the bulk enable SaaS operation

Example (auto)

{
  "success": true,
  "message": "Bulk enable SaaS operation completed successfully",
  "bulkActionUrl": "https://example.com/bulk-enable-saas"
}