PATCH
/
v3
/
plans
/
{planId}
Update Plan Catalog Entry
curl --request PATCH \
  --url http://127.0.0.1:3333/v3/plans/{planId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'
{
  "id": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "name": "HOBBY",
  "price": 123,
  "prices": {
    "brl": 123,
    "usd": 123,
    "eur": 123,
    "gbp": 123
  },
  "creditsLimit": 123,
  "seatsLimit": 123,
  "storageLimit": 123,
  "color": "<string>",
  "badgeTone": "popular",
  "badgeLabel": "<string>",
  "displayOrder": 123,
  "isPublic": true,
  "displayName": "<string>",
  "description": "<string>",
  "ctaLabel": "<string>",
  "features": [
    "<string>"
  ],
  "comparisonData": {
    "usage": {
      "bots": "unlimited",
      "servers": "unlimited",
      "guests": "unlimited"
    },
    "platform": {
      "blocks": true,
      "templates": true,
      "files": true,
      "folders": true,
      "watermark": true,
      "domains": true,
      "export": true,
      "js_css": true
    },
    "channels": {
      "evolution_api": true,
      "whatsapp_api": true,
      "whatsapp_unlimited": true
    },
    "integrations": {
      "webhooks": true,
      "sheets": true,
      "analytics": true,
      "zapier": true,
      "pabbly": true,
      "make": true,
      "emails": true
    },
    "support": {
      "support_bot": true,
      "support_email": true,
      "support_priority": true,
      "support_dedicated": true
    }
  },
  "translations": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

planId
integer
required
Required range: x > 0

Query Parameters

locale
string

Body

application/json
price
number
Required range: x >= 0
prices
object
creditsLimit
integer
Required range: x > 0
seatsLimit
integer
Required range: x > 0
storageLimit
integer
Required range: x > 0
color
string
Minimum string length: 1
badgeTone
enum<string> | null
Available options:
popular,
enterprise
displayOrder
integer
Required range: x >= 0
isPublic
boolean
translations
object
comparisonData
object

Response

Default Response

id
number
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
name
enum<string>
required
Available options:
HOBBY,
CORE,
SCALE,
DEDICATED
price
number
required
prices
object
required
creditsLimit
number
required
seatsLimit
number
required
storageLimit
number
required
color
string
required
badgeTone
enum<string> | null
required
Available options:
popular,
enterprise
badgeLabel
string | null
required
displayOrder
number
required
isPublic
boolean
required
displayName
string
required
description
string
required
ctaLabel
string
required
features
string[]
required
comparisonData
object
required
translations
object
required