APIs Administrativas › Planos › API Atualizar Plano

API Atualizar Plano

Todas

Atualiza um plano, mudando apenas os campos que você enviar.

Esta chamada exige um token da empresa do Super Admin.

Endpoint

https://{BACKEND_URL}/api/plans/{planId}

Método

PUT

Autenticação

Bearer {seutokenaqui}

Payload

{
    "name": "Profissional",
    "users": 15,
    "connections": 3,
    "connectionLimits": {
        "whatsappMeta": 1
    },
    "queues": 10,
    "value": 249.90,
    "useWhatsapp": true,
    "useFacebook": false,
    "useInstagram": false,
    "useCampaigns": true,
    "useSchedules": true,
    "useInternalChat": false,
    "useExternalApi": true,
    "useKanban": true,
    "usePixel": false,
    "usePerfex": false,
    "useRD": false,
    "useCV": false,
    "useIXC": false,
    "useAI": true,
    "useCHAMA": false,
    "useTYPE": false,
    "useZAIA": false,
    "useGPT": true,
    "useGPTA": false,
    "useAnswerFromIA": false,
    "useHS": false,
    "useNNN": false,
    "useHUB": false,
    "useCRM": true,
    "useFLOW": true,
    "useBTN": false,
    "useCALL": false,
    "useVOIP": false,
    "useVIDEOCALL": false,
    "useVoiceBilling": false,
    "useDIFY": false,
    "usePUSH": false,
    "useWABAOWN": false,
    "useWABAAINI": false,
    "useProducts": true,
    "useServices": false,
    "useWEBCHAT": false,
    "useCHATEXTERNO": false,
    "useTELEGRAMAINI": false,
    "useINSTAGRAMAINI": false,
    "useTIKTOKAINI": false,
    "useFACEBOOKAINI": false,
    "useFACEBOOKPORTAL": false,
    "useINSTAGRAMPORTAL": false,
    "useInstagramAuto": false,
    "useEMAIL": false,
    "useRCS": false,
    "useAIPROVIDERS": false,
    "useCRMCOPILOT": false,
    "useMobileDocker": false,
    "useQuadro": true,
    "useInternal": false
}

“planId”: ID do plano — vai no próprio endereço, no lugar de {planId}. Obrigatório.

“name”: nome do plano, com pelo menos 2 caracteres e único.

“users”: quantos usuários a empresa pode ter.

“connections”: quantas conexões a empresa pode ter, no total.

“queues”: quantos Setores a empresa pode ter.

“value”: valor do plano.

“connectionLimits”: teto por grupo de canal — whatsapp, whatsappMeta, hub, telegramInc e os demais. Grupo que você não informar herda o limite geral de connections.

Os módulos do plano são os campos que começam com use, cada um true ou false. Cada um corresponde a uma opção da tela de Planos:

useWhatsapp, useFacebook, useInstagram, useCampaigns, useSchedules, useInternalChat, useExternalApi, useKanban, usePixel, usePerfex, useRD, useCV, useIXC, useAI, useCHAMA, useTYPE, useZAIA, useGPT, useGPTA, useAnswerFromIA, useHS, useNNN, useHUB, useCRM, useFLOW, useBTN, useCALL, useVOIP, useVIDEOCALL, useVoiceBilling, useDIFY, usePUSH, useWABAOWN, useWABAAINI, useProducts, useServices, useWEBCHAT, useCHATEXTERNO, useTELEGRAMAINI, useINSTAGRAMAINI, useTIKTOKAINI, useFACEBOOKAINI, useFACEBOOKPORTAL, useINSTAGRAMPORTAL, useInstagramAuto, useEMAIL, useRCS, useAIPROVIDERS, useCRMCOPILOT, useMobileDocker, useQuadro, useInternal.

A lista de módulos cresce. Quando a plataforma ganha um recurso novo, ele aparece aqui sem aviso — para ver a lista de hoje, consulte um plano que já existe e olhe os campos use da resposta.

Nem todo módulo do plano tem campo na tela: o useProducts, por exemplo, está no plano e não aparece lá.

A chamada passa pela mesma conferência da tela: módulo que a tela de Planos recusa também é recusado aqui.

O exemplo acima traz tudo o que a chamada aceita, para você escolher — não é obrigatório enviar inteiro. O que você não mandar fica como está.

Nenhum campo é obrigatório, mas é preciso mandar pelo menos um — senão a chamada é recusada.

A mudança vale na hora para todas as empresas que estão naquele plano. Diminuir um limite atinge quem já passou dele, e desligar um módulo tira o recurso de todas elas.

Plano que não existe responde 404.

Não existe exclusão de plano pela API.

Utilize o código em requisições HTTPS com ferramentas como cURL ou bibliotecas de integração.

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{BACKEND_URL}/api/plans/{planId}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'{
    "name": "Profissional",
    "users": 15,
    "connections": 3,
    "connectionLimits": {
        "whatsappMeta": 1
    },
    "queues": 10,
    "value": 249.90,
    "useWhatsapp": true,
    "useFacebook": false,
    "useInstagram": false,
    "useCampaigns": true,
    "useSchedules": true,
    "useInternalChat": false,
    "useExternalApi": true,
    "useKanban": true,
    "usePixel": false,
    "usePerfex": false,
    "useRD": false,
    "useCV": false,
    "useIXC": false,
    "useAI": true,
    "useCHAMA": false,
    "useTYPE": false,
    "useZAIA": false,
    "useGPT": true,
    "useGPTA": false,
    "useAnswerFromIA": false,
    "useHS": false,
    "useNNN": false,
    "useHUB": false,
    "useCRM": true,
    "useFLOW": true,
    "useBTN": false,
    "useCALL": false,
    "useVOIP": false,
    "useVIDEOCALL": false,
    "useVoiceBilling": false,
    "useDIFY": false,
    "usePUSH": false,
    "useWABAOWN": false,
    "useWABAAINI": false,
    "useProducts": true,
    "useServices": false,
    "useWEBCHAT": false,
    "useCHATEXTERNO": false,
    "useTELEGRAMAINI": false,
    "useINSTAGRAMAINI": false,
    "useTIKTOKAINI": false,
    "useFACEBOOKAINI": false,
    "useFACEBOOKPORTAL": false,
    "useINSTAGRAMPORTAL": false,
    "useInstagramAuto": false,
    "useEMAIL": false,
    "useRCS": false,
    "useAIPROVIDERS": false,
    "useCRMCOPILOT": false,
    "useMobileDocker": false,
    "useQuadro": true,
    "useInternal": false
}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'Authorization: Bearer {seutokenaqui}' //Token cadastrado na conexão
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;