Integrations
HighLevel
Connect a HighLevel (GoHighLevel) Private Integration Token to Alter Vault for governed access to CRM, messaging, and marketing data
Overview
Section titled “Overview”HighLevel (formerly GoHighLevel) runs CRM, messaging, calendars, invoicing, and marketing automation for agencies and their sub-accounts. A HighLevel agency or sub-account can create a Private Integration Token for itself and store it in Alter Vault; agents then call HighLevel’s API through Alter without ever holding the token, and every call is governed by Alter policy.
This page covers the Private Integration Token. To connect customers’ HighLevel accounts through a HighLevel Marketplace app (OAuth), see HighLevel OAuth.
| Property | Value |
|---|---|
| Template ID | gohighlevel |
| Category | CRM |
| Credential Type | Private Integration Token |
| API host | services.leadconnectorhq.com |
Step 1: Create a Private Integration
Section titled “Step 1: Create a Private Integration”Open Private Integrations
Sign in to HighLevel as an agency admin, or a user allowed to manage Private Integrations, and open the agency or sub-account the token is for. Go to Settings → Private Integrations. If it is missing, enable Private Integrations under Labs.
Create the integration
Click Create new Integration and give it a name and description.
Select scopes
Select only the scopes the integration needs.
Copy the token
Copy the generated token. HighLevel shows it only once.
Step 2: Add to Alter Vault
Section titled “Step 2: Add to Alter Vault”Open the Developer Portal
Go to portal.alterauth.com and navigate to the application.
Add HighLevel
Go to Managed Secrets > Add Provider > HighLevel.
Enter the token
Paste the Private Integration Token into the credential field and set the allowed host to services.leadconnectorhq.com.
Save
Click Save. You’ll receive a grant_id to use with the SDK. HighLevel refuses every request without a Version header, which a save-time check cannot send, so the save reports the token as not verified.
Using in Code
Section titled “Using in Code”Every HighLevel API call needs a Version header: v3 (the current version), or a date version such as 2021-07-28. Alter injects the token; send Version with each request.
response = await alter_app.request( HttpMethod.GET, "https://services.leadconnectorhq.com/locations/LOCATION_ID", grant_id="YOUR_GRANT_ID", extra_headers={"Version": "v3"},)Grants with policy rules
Section titled “Grants with policy rules”request hands the token to the application, which then calls HighLevel itself, so Alter never sees the request. Alter can only enforce an approval rule, a method and endpoint restriction, or a content rule (one that names an operation, a family, or a request field) on a call it makes itself. Once any such rule applies to the grant, at any level, every request on that grant is refused with RestrictedGrantRequiresProxyError (errors). Use proxy_request for a grant that carries the rules in Policy: it sends the whole request to Alter, which checks it against the rules, injects the token, and calls HighLevel.
result = await alter_app.proxy_request( HttpMethod.POST, "https://services.leadconnectorhq.com/conversations/messages", grant_id="YOUR_GRANT_ID", extra_headers={"Version": "v3"}, json={ "type": "SMS", "contactId": "CONTACT_ID", "toNumber": "+15555550100", "message": "The appointment is confirmed for 3 PM.", }, reason="Confirm the contact's appointment by SMS",)proxy_request returns an ApprovalResult with HighLevel’s status_code and body (result.body_json()), or a PendingApproval when a rule requires a person to approve the call first; see human-in-the-loop approvals. A recipients rule judges the body Alter sends, so it works only through proxy_request.
Each user’s own token
Section titled “Each user’s own token”Instead of one shared token, each end user can store a Private Integration Token of their own through Connect, and the application then calls HighLevel as that user’s account (End users’ own keys):
session = await alter_app.create_managed_secret_connect_session( provider="highlevel-production", # the provider's slug, not the template id user_token=user_jwt,)The Connect page shows the user the steps above and asks for the token. The scopes the application asks the token to have are chosen from HighLevel’s scope catalog (the scopes table, less the charges.*, oauth.readonly, and marketplace-installer-details.readonly scopes, which only marketplace-app routes use), with the descriptions shown there: set them in the provider’s End-user key setup card, or with alter managed-secrets set-end-user-key-setup <provider> --scope contacts.readonly --scope locations.readonly. A scope outside the catalog is refused. The scopes are shown to the user as guidance: HighLevel enforces the token’s real scopes itself.
Policy
Section titled “Policy”Every call made with a HighLevel grant runs through Alter’s policy rules: method and endpoint restrictions, IP allowlists, time windows, quotas, human approval, AI review, and content rules that deny, redact, or require step-up. Rules can be attached to the organization, the application, an agent, a grant, an end user, or this provider.
Content rules can name a HighLevel operation from the table below, a family, or a request field. The families are the same as for the OAuth route; see the family table. A Private Integration Token cannot call the routes HighLevel reserves for marketplace apps (installed-location lookups, installer details, app rebilling configuration, and marketplace wallet charges), so those are not in this catalog. The two token routes, the marketplace token exchange and sub-account token minting, are in it so that Alter refuses them by name: they return a new HighLevel credential, which Alter never hands to a caller.
send covers what a call delivers itself; writes that only start a workflow the sub-account has configured (adding a contact tag, creating a contact, moving an opportunity) are write, and the OAuth page lists them so a rule can name them. The recipients parameter works the same way on both routes: a message that does not name its destination address or number, a reply_all, or a forward to a contact by id cannot be judged, so a rule that names recipients refuses it.
Typical rules:
- Require human approval for the
sendfamily, so no message, invoice, estimate, or post a call sends reaches a customer without a person approving it. - Require approval for the
paymentfamily on agent grants. - Restrict a grant to
GETon/contacts/*for a read-only reporting agent.
Use alter policy simulate or Explain a request in the Developer Portal to see which operation and family a HighLevel request classifies as before you rely on a rule. See Policies and Set policies.
- The token is injected as
Authorization: Bearer <token>. - HighLevel recommends rotating Private Integration Tokens every 90 days. Rotate and expire this token later keeps the old token working for 7 days, so rotate the provider’s credential in Alter within that window (Developer Portal, or
alter managed-secrets credentials rotate). A user whose own token was rotated replaces it through a new managed-secret Connect session withrepair_grant_id(repairGrantIdin TypeScript). - A sub-account token reaches that sub-account; an agency token reaches agency APIs.
- HighLevel enforces the token’s scopes itself. A call outside them is refused by HighLevel.
- Alter’s policy catalog covers HighLevel’s v3 API reference. A route that exists only in an earlier date version is unclassified, so a rule that names operations or families refuses it.
Policy-cataloged operations
Section titled “Policy-cataloged operations”Alter policy rules can target these attested operations and families for operation-level and parameter-aware controls.
| Operation ID | Families | Method | Provider path | Notes |
|---|---|---|---|---|
fb-get-ad-accounts | read | GET | /ad-publishing/facebook/ad-accounts | — |
fb-delete-ad-account | delete, payment | DELETE | /ad-publishing/facebook/ad-accounts/{adAccountId} | — |
fb-get-ad-account | read | GET | /ad-publishing/facebook/ad-accounts/{adAccountId} | — |
fb-upsert-ad | payment, write | PUT | /ad-publishing/facebook/ads | — |
fb-delete-ad | delete, payment | DELETE | /ad-publishing/facebook/ads/{adId} | — |
fb-duplicate-ad | payment, write | POST | /ad-publishing/facebook/ads/{adId}/duplicate | — |
fb-pause-ad | payment, write | POST | /ad-publishing/facebook/ads/{adId}/pause | — |
fb-resume-ad | payment, send, write | POST | /ad-publishing/facebook/ads/{adId}/resume | — |
fb-upsert-adset | payment, write | PUT | /ad-publishing/facebook/adsets | — |
fb-delete-adset | delete, payment | DELETE | /ad-publishing/facebook/adsets/{adSetId} | — |
fb-duplicate-adset | payment, write | POST | /ad-publishing/facebook/adsets/{adSetId}/duplicate | — |
fb-pause-adset | payment, write | POST | /ad-publishing/facebook/adsets/{adSetId}/pause | — |
fb-resume-adset | payment, send, write | POST | /ad-publishing/facebook/adsets/{adSetId}/resume | — |
fb-get-campaign | read | GET | /ad-publishing/facebook/campaign/{campaignId} | — |
fb-upsert-campaign | payment, write | PUT | /ad-publishing/facebook/campaigns | — |
fb-delete-campaign | delete, payment | DELETE | /ad-publishing/facebook/campaigns/{campaignId} | — |
fb-duplicate-campaign | payment, write | POST | /ad-publishing/facebook/campaigns/{campaignId}/duplicate | — |
fb-pause-campaign | payment, write | POST | /ad-publishing/facebook/campaigns/{campaignId}/pause | — |
fb-publish-campaign | payment, send, write | POST | /ad-publishing/facebook/campaigns/{campaignId}/publish | — |
fb-get-campaign-publishing-progress | read | GET | /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress | — |
fb-resume-campaign | payment, send, write | POST | /ad-publishing/facebook/campaigns/{campaignId}/resume | — |
fb-get-conversation-forms | read | GET | /ad-publishing/facebook/conversation-forms | — |
fb-create-conversation-form | payment, write | POST | /ad-publishing/facebook/conversation-forms | — |
fb-get-custom-audiences | read | GET | /ad-publishing/facebook/custom-audience | — |
fb-delete-custom-audience | delete, payment | DELETE | /ad-publishing/facebook/custom-audience/{audienceId} | — |
fb-get-custom-audience-by-id | read | GET | /ad-publishing/facebook/custom-audience/{audienceId} | — |
fb-update-custom-audience | payment, write | PUT | /ad-publishing/facebook/custom-audience/{audienceId} | — |
fb-remove-custom-audience-member | delete, payment | DELETE | /ad-publishing/facebook/custom-audience/{audienceId}/member | — |
fb-add-custom-audience-member | payment, write | PUT | /ad-publishing/facebook/custom-audience/{audienceId}/member | — |
fb-batch-update-audience-members | payment, write | PUT | /ad-publishing/facebook/custom-audience/{audienceId}/member/batch | — |
fb-get-entity | read | GET | /ad-publishing/facebook/entity | — |
fb-delete-integration | delete, payment | DELETE | /ad-publishing/facebook/integration | — |
fb-get-integration | read | GET | /ad-publishing/facebook/integration | — |
fb-create-integration | payment, write | POST | /ad-publishing/facebook/integration | — |
fb-get-lead-form | read | GET | /ad-publishing/facebook/lead-form/{leadFormId} | — |
fb-get-current-user | read | GET | /ad-publishing/facebook/me | — |
fb-delete-page | delete, payment | DELETE | /ad-publishing/facebook/page | — |
fb-set-default-page | payment, write | PUT | /ad-publishing/facebook/page/default | — |
fb-get-page-lead-forms | read | GET | /ad-publishing/facebook/page/{pageId}/forms | — |
fb-create-page-lead-form | payment, write | POST | /ad-publishing/facebook/page/{pageId}/forms | — |
fb-get-instagram-accounts | read | GET | /ad-publishing/facebook/page/{pageId}/instagram | — |
fb-get-pages | read | GET | /ad-publishing/facebook/pages | — |
fb-get-pixels | read | GET | /ad-publishing/facebook/pixels | — |
fb-upsert-pixel | payment, write | PUT | /ad-publishing/facebook/pixels | — |
fb-get-reporting | read | GET | /ad-publishing/facebook/reporting | — |
fb-get-campaign-reporting | read | GET | /ad-publishing/facebook/reporting/campaign/{campaignId} | — |
fb-get-reporting-list | read | GET | /ad-publishing/facebook/reporting/list | — |
fb-search-targeting | read | GET | /ad-publishing/facebook/targeting/search | — |
google-get-ad-accounts | read | GET | /ad-publishing/google/ad-accounts | — |
google-delete-ad-account | delete, payment | DELETE | /ad-publishing/google/ad-accounts/{adAccountId} | — |
google-get-ad-account-details | read | GET | /ad-publishing/google/ad-accounts/{adAccountId} | — |
google-upsert-campaign | payment, send, write | PUT | /ad-publishing/google/ads | — |
google-get-campaign-by-id | read | GET | /ad-publishing/google/ads/{adId} | — |
google-publish-ad | payment, send, write | POST | /ad-publishing/google/ads/{adId}/publish | — |
google-get-assets | read | GET | /ad-publishing/google/assets | — |
google-upsert-assets | payment, write | POST | /ad-publishing/google/assets | — |
google-get-audiences | read | GET | /ad-publishing/google/audiences | — |
google-upsert-audience | payment, write | PUT | /ad-publishing/google/audiences | — |
google-get-audience-by-id | read | GET | /ad-publishing/google/audiences/{audienceId} | — |
google-get-conversion-goals | read | GET | /ad-publishing/google/conversion-goals | — |
google-get-conversions | read | GET | /ad-publishing/google/conversions | — |
google-upsert-conversion | payment, write | PUT | /ad-publishing/google/conversions | — |
google-delete-conversion | delete, payment | DELETE | /ad-publishing/google/conversions/{conversionId} | — |
google-get-conversion-by-id | read | GET | /ad-publishing/google/conversions/{conversionId} | — |
google-get-entity | read | GET | /ad-publishing/google/entity | — |
google-get-integration | read | GET | /ad-publishing/google/integration | — |
google-create-integration | payment, write | POST | /ad-publishing/google/integration | — |
google-get-keyword-ideas | read | POST | /ad-publishing/google/keyword-ideas | — |
google-get-current-user | read | GET | /ad-publishing/google/me | — |
google-get-reporting | read | GET | /ad-publishing/google/reporting | — |
google-get-campaign-reporting | read | GET | /ad-publishing/google/reporting/campaign/{campaignId} | — |
google-get-reporting-list | read | GET | /ad-publishing/google/reporting/list | — |
google-get-segments | read | GET | /ad-publishing/google/segments | — |
google-upsert-segment | payment, write | PUT | /ad-publishing/google/segments | — |
google-create-offline-user-list-job | payment, write | POST | /ad-publishing/google/segments/offline-user-list-job | — |
google-delete-segment | delete, payment | DELETE | /ad-publishing/google/segments/{segmentId} | — |
google-get-segment-by-id | read | GET | /ad-publishing/google/segments/{segmentId} | — |
google-get-target-interests | read | GET | /ad-publishing/google/target-interests | — |
google-search-targeting | read | GET | /ad-publishing/google/targeting/search | — |
li-delete-ad-account | delete, payment | DELETE | /ad-publishing/linkedin/ad-account | — |
li-get-ad-account-details | read | GET | /ad-publishing/linkedin/ad-account | — |
li-get-ad-accounts | read | GET | /ad-publishing/linkedin/ad-accounts | — |
li-upsert-campaign-group | payment, send, write | PUT | /ad-publishing/linkedin/ads | — |
li-get-campaign-group | read | GET | /ad-publishing/linkedin/ads/{adId} | — |
li-publish-campaign-group | payment, send, write | POST | /ad-publishing/linkedin/ads/{adId}/publish | — |
li-get-integration | read | GET | /ad-publishing/linkedin/integration | — |
li-create-integration | payment, write | POST | /ad-publishing/linkedin/integration | — |
li-get-current-user | read | GET | /ad-publishing/linkedin/me | — |
li-get-ad-analytics | read | GET | /ad-publishing/linkedin/reporting | — |
li-get-campaign-group-reporting | read | GET | /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId} | — |
li-get-reporting-list | read | GET | /ad-publishing/linkedin/reporting/list | — |
li-search-targeting | read | GET | /ad-publishing/linkedin/targeting/search | — |
li-create-lead-form | payment, send, write | POST | /ad-publishing/linkedin/{accountId}/form | — |
li-get-lead-forms | read | GET | /ad-publishing/linkedin/{accountId}/forms | — |
li-update-ad-status | payment, send, write | PATCH | /ad-publishing/linkedin/{adId}/status | — |
list-affiliates | read | GET | /affiliate-manager/{locationId}/affiliates | — |
get-affiliate | read | GET | /affiliate-manager/{locationId}/affiliates/{affiliateId} | — |
list-commissions | read | GET | /affiliate-manager/{locationId}/commissions | — |
list-payouts | read | GET | /affiliate-manager/{locationId}/payouts | — |
getAgents | read | GET | /agent-studio/agent | — |
createAgent | admin, write | POST | /agent-studio/agent | — |
updateAgentVersion | admin, write | PATCH | /agent-studio/agent/versions/{versionId} | — |
promoteAndPublish | admin, write | POST | /agent-studio/agent/versions/{versionId}/publish | — |
deleteAgent | admin, delete | DELETE | /agent-studio/agent/{agentId} | — |
getAgentById | read | GET | /agent-studio/agent/{agentId} | — |
updateAgentMetadata | admin, write | PATCH | /agent-studio/agent/{agentId} | — |
executeAgent | send, write | POST | /agent-studio/agent/{agentId}/execute | — |
getAgents-deprecated | read | GET | /agent-studio/public-api/agents | — |
getAgentById-deprecated | read | GET | /agent-studio/public-api/agents/{agentId} | — |
executeAgent-deprecated | send, write | POST | /agent-studio/public-api/agents/{agentId}/execute | — |
find-associations | read | GET | /associations/ | — |
associations.create-association | admin, write | POST | /associations/ | — |
get-association-key-by-key-name | read | GET | /associations/key/{key_name} | — |
get-association-by-object-keys | read | GET | /associations/objectKey/{objectKey} | — |
create-relation | write | POST | /associations/relations | — |
get-relations-by-record-id | read | GET | /associations/relations/{recordId} | — |
delete-relation | delete | DELETE | /associations/relations/{relationId} | — |
delete-association | admin, delete | DELETE | /associations/{associationId} | — |
get-association-by-ID | read | GET | /associations/{associationId} | — |
update-association | admin, write | PUT | /associations/{associationId} | — |
get-all-blog-authors-by-location | read | GET | /blogs/authors | — |
get-all-categories-by-location | read | GET | /blogs/categories | — |
create-blog-post | send, write | POST | /blogs/posts | — |
get-blog-post | read | GET | /blogs/posts/all | — |
check-url-slug-exists | read | GET | /blogs/posts/url-slug-exists | — |
update-blog-post | send, write | PUT | /blogs/posts/{postId} | — |
get-blogs | read | GET | /blogs/site/all | — |
createBrandBoard | write | POST | /brand-boards/ | — |
list-brand-voices | read | GET | /brand-boards/locations/{locationId}/brand-voices | — |
create-brand-voice | write | POST | /brand-boards/locations/{locationId}/brand-voices | — |
delete-brand-voice | delete | DELETE | /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} | — |
get-brand-voice | read | GET | /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} | — |
update-brand-voice | write | PATCH | /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId} | — |
set-default-brand-voice | write | POST | /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default | — |
getBrandBoardsByLocation | read | GET | /brand-boards/{locationId} | — |
deleteBrandBoard | delete | DELETE | /brand-boards/{locationId}/{id} | — |
getBrandBoardById | read | GET | /brand-boards/{locationId}/{id} | — |
updateBrandBoard | write | PATCH | /brand-boards/{locationId}/{id} | — |
get-businesses-by-location | read | GET | /businesses/ | — |
create-business | write | POST | /businesses/ | — |
delete-Business | delete | DELETE | /businesses/{businessId} | — |
get-business | read | GET | /businesses/{businessId} | — |
update-business | write | PUT | /businesses/{businessId} | — |
get-calendars | read | GET | /calendars/ | — |
create-calendar | admin, payment, write | POST | /calendars/ | — |
get-appointment-notes | read | GET | /calendars/appointments/{appointmentId}/notes | — |
create-appointment-note | write | POST | /calendars/appointments/{appointmentId}/notes | — |
delete-appointment-note | delete | DELETE | /calendars/appointments/{appointmentId}/notes/{noteId} | — |
update-appointment-note | write | PUT | /calendars/appointments/{appointmentId}/notes/{noteId} | — |
get-blocked-slots | read | GET | /calendars/blocked-slots | — |
get-calendar-events | read | GET | /calendars/events | — |
create-appointment | send, write | POST | /calendars/events/appointments | — |
get-appointment | read | GET | /calendars/events/appointments/{eventId} | — |
edit-appointment | send, write | PUT | /calendars/events/appointments/{eventId} | — |
create-block-slot | write | POST | /calendars/events/block-slots | — |
edit-block-slot | write | PUT | /calendars/events/block-slots/{eventId} | — |
delete-event | delete, send | DELETE | /calendars/events/{eventId} | — |
get-groups | read | GET | /calendars/groups | — |
create-calendar-group | write | POST | /calendars/groups | — |
validate-groups-slug | read | POST | /calendars/groups/validate-slug | — |
delete-group | delete | DELETE | /calendars/groups/{groupId} | — |
edit-group | write | PUT | /calendars/groups/{groupId} | — |
disable-group | write | PUT | /calendars/groups/{groupId}/status | — |
fetch-calendar-resources | read | GET | /calendars/resources/{resourceType} | — |
create-calendar-resource | write | POST | /calendars/resources/{resourceType} | — |
delete-calendar-resource | delete | DELETE | /calendars/resources/{resourceType}/{id} | — |
get-calendar-resource | read | GET | /calendars/resources/{resourceType}/{id} | — |
update-calendar-resource | write | PUT | /calendars/resources/{resourceType}/{id} | — |
createSchedule | write | POST | /calendars/schedules | — |
getCalendarSchedule | read | GET | /calendars/schedules/event-calendar/{calendarId} | — |
createCalendarSchedule | write | POST | /calendars/schedules/event-calendar/{calendarId} | — |
updateCalendarSchedule | write | PUT | /calendars/schedules/event-calendar/{calendarId} | — |
getAllSchedules | read | GET | /calendars/schedules/search | — |
deleteSchedule | delete | DELETE | /calendars/schedules/{id} | — |
getScheduleById | read | GET | /calendars/schedules/{id} | — |
updateSchedule | write | PUT | /calendars/schedules/{id} | — |
remove-calendar-from-schedule | delete | DELETE | /calendars/schedules/{id}/associations/{calendarId} | — |
add-calendar-to-schedule | write | PUT | /calendars/schedules/{id}/associations/{calendarId} | — |
get-service-bookings | read | GET | /calendars/services/bookings | — |
create-service-booking | send, write | POST | /calendars/services/bookings | — |
delete-service-booking | delete, send | DELETE | /calendars/services/bookings/{bookingId} | — |
get-service-booking-by-id | read | GET | /calendars/services/bookings/{bookingId} | — |
update-service-booking | send, write | PUT | /calendars/services/bookings/{bookingId} | — |
get-services-catalog | read | GET | /calendars/services/catalog | — |
create-service-catalog | payment, write | POST | /calendars/services/catalog | — |
delete-service-catalog | delete | DELETE | /calendars/services/catalog/{serviceId} | — |
get-service-catalog-by-id | read | GET | /calendars/services/catalog/{serviceId} | — |
update-service-catalog | payment, write | PUT | /calendars/services/catalog/{serviceId} | — |
get-service-locations | read | GET | /calendars/services/locations | — |
create-service-location | write | POST | /calendars/services/locations | — |
delete-service-location | delete | DELETE | /calendars/services/locations/{serviceLocationId} | — |
get-service-location-by-id | read | GET | /calendars/services/locations/{serviceLocationId} | — |
update-service-location | write | PUT | /calendars/services/locations/{serviceLocationId} | — |
delete-calendar | delete | DELETE | /calendars/{calendarId} | — |
get-calendar | read | GET | /calendars/{calendarId} | — |
update-calendar | admin, payment, write | PUT | /calendars/{calendarId} | — |
get-slots | read | GET | /calendars/{calendarId}/free-slots | — |
get-event-notification | read | GET | /calendars/{calendarId}/notifications | — |
create-event-notification | admin, write | POST | /calendars/{calendarId}/notifications | — |
delete-event-notification | admin, delete | DELETE | /calendars/{calendarId}/notifications/{notificationId} | — |
find-event-notification | read | GET | /calendars/{calendarId}/notifications/{notificationId} | — |
update-event-notification | admin, write | PUT | /calendars/{calendarId}/notifications/{notificationId} | — |
get-campaigns | read | GET | /campaigns/ | — |
createChatWidget | admin, write | POST | /chat-widget/ | — |
cloneChatWidget | admin, write | POST | /chat-widget/clone | — |
getChatWidget | read | GET | /chat-widget/data/{locationId}/{id} | — |
patchChatWidget | admin, write | PATCH | /chat-widget/data/{locationId}/{id} | — |
updateChatWidget | admin, write | PUT | /chat-widget/data/{locationId}/{id} | — |
listChatWidget | read | GET | /chat-widget/list | — |
getWidget | read | GET | /chat-widget/public/config/{id} | — |
chat-widget.delete | admin, delete | DELETE | /chat-widget/{locationId}/{id} | — |
get-company | read | GET | /companies/{companyId} | — |
create-contact | write | POST | /contacts/ | — |
add-remove-contact-from-business | write | POST | /contacts/bulk/business | — |
contacts.bulk-update-tags | delete, write | POST | /contacts/bulk/tags/update/{type} | — |
get-contacts-by-businessId | read | GET | /contacts/business/{businessId} | — |
search-contacts-advanced | read | POST | /contacts/search | — |
get-duplicate-contact | read | GET | /contacts/search/duplicate | — |
upsert-contact | write | POST | /contacts/upsert | — |
delete-contact | delete | DELETE | /contacts/{contactId} | — |
get-contact | read | GET | /contacts/{contactId} | — |
update-contact | write | PUT | /contacts/{contactId} | — |
get-appointments-for-contact | read | GET | /contacts/{contactId}/appointments | — |
remove-contact-from-every-campaign | delete | DELETE | /contacts/{contactId}/campaigns/remove-all | also served at /contacts/{contactId}/campaigns/removeAll |
remove-contact-from-campaign | delete | DELETE | /contacts/{contactId}/campaigns/{campaignId} | — |
add-contact-to-campaign | send, write | POST | /contacts/{contactId}/campaigns/{campaignId} | — |
remove-followers-contact | delete | DELETE | /contacts/{contactId}/followers | — |
add-followers-contact | write | POST | /contacts/{contactId}/followers | — |
get-all-notes | read | GET | /contacts/{contactId}/notes | — |
create-note | write | POST | /contacts/{contactId}/notes | — |
delete-note | delete | DELETE | /contacts/{contactId}/notes/{id} | — |
get-note | read | GET | /contacts/{contactId}/notes/{id} | — |
update-note | write | PUT | /contacts/{contactId}/notes/{id} | — |
remove-tags | delete | DELETE | /contacts/{contactId}/tags | — |
add-tags | write | POST | /contacts/{contactId}/tags | — |
get-all-tasks | read | GET | /contacts/{contactId}/tasks | — |
create-task | write | POST | /contacts/{contactId}/tasks | — |
delete-task | delete | DELETE | /contacts/{contactId}/tasks/{taskId} | — |
get-task | read | GET | /contacts/{contactId}/tasks/{taskId} | — |
update-task | write | PUT | /contacts/{contactId}/tasks/{taskId} | — |
update-task-completed | write | PUT | /contacts/{contactId}/tasks/{taskId}/completed | — |
delete-contact-from-workflow | delete | DELETE | /contacts/{contactId}/workflow/{workflowId} | — |
add-contact-to-workflow | send, write | POST | /contacts/{contactId}/workflow/{workflowId} | — |
conversation-ai.create-agent | admin, write | POST | /conversation-ai/agents | — |
search-agent | read | GET | /conversation-ai/agents/search | — |
conversation-ai.delete-agent | admin, delete | DELETE | /conversation-ai/agents/{agentId} | — |
conversation-ai.get-agent | read | GET | /conversation-ai/agents/{agentId} | — |
update-agent | admin, write | PUT | /conversation-ai/agents/{agentId} | — |
conversation-ai.create-action | admin, write | POST | /conversation-ai/agents/{agentId}/actions | — |
list-actions | read | GET | /conversation-ai/agents/{agentId}/actions/list | — |
conversation-ai.delete-action | admin, delete | DELETE | /conversation-ai/agents/{agentId}/actions/{actionId} | — |
get-action-by-id | read | GET | /conversation-ai/agents/{agentId}/actions/{actionId} | — |
conversation-ai.update-action | admin, write | PUT | /conversation-ai/agents/{agentId}/actions/{actionId} | — |
update-followup-settings | admin, write | PATCH | /conversation-ai/agents/{agentId}/followup-settings | — |
get-generation-details | read | GET | /conversation-ai/generations | — |
create-conversation | write | POST | /conversations/ | — |
get-message-transcription | read | GET | /conversations/locations/{locationId}/messages/{messageId}/transcription | — |
download-message-transcription | read | GET | /conversations/locations/{locationId}/messages/{messageId}/transcription/download | — |
send-a-new-message | send, write | POST | /conversations/messages | — |
cancel-scheduled-email-message | delete | DELETE | /conversations/messages/email/{emailMessageId}/schedule | — |
get-email-by-id | read | GET | /conversations/messages/email/{id} | — |
update-email-message-status | write | PUT | /conversations/messages/email/{id}/status | — |
export-messages-by-location | read | GET | /conversations/messages/export | — |
add-an-inbound-message | write | POST | /conversations/messages/inbound | — |
add-an-outbound-message | write | POST | /conversations/messages/outbound | — |
send-review-reply | send, write | POST | /conversations/messages/review-reply | — |
upload-file-attachments | write | POST | /conversations/messages/upload | — |
complete-file-upload | write | POST | /conversations/messages/upload/complete | — |
initiate-file-upload | write | POST | /conversations/messages/upload/initiate | — |
get-message | read | GET | /conversations/messages/{id} | — |
add-message-attachments | write | PUT | /conversations/messages/{messageId}/attachments | — |
get-message-recording | read | GET | /conversations/messages/{messageId}/locations/{locationId}/recording | — |
cancel-scheduled-message | delete | DELETE | /conversations/messages/{messageId}/schedule | — |
update-message-status | write | PUT | /conversations/messages/{messageId}/status | — |
live-chat-agent-typing | send, write | POST | /conversations/providers/live-chat/typing | — |
search-conversation | read | GET | /conversations/search | — |
delete-conversation | delete | DELETE | /conversations/{conversationId} | — |
get-conversation | read | GET | /conversations/{conversationId} | — |
update-conversation | write | PUT | /conversations/{conversationId} | — |
get-messages | read | GET | /conversations/{conversationId}/messages | — |
import-courses | write | POST | /courses/courses-exporter/public/import | — |
custom-fields.create-custom-field | admin, write | POST | /custom-fields/ | — |
create-custom-field-folder | admin, write | POST | /custom-fields/folder | — |
delete-custom-field-folder | admin, delete | DELETE | /custom-fields/folder/{id} | — |
update-custom-field-folder | admin, write | PUT | /custom-fields/folder/{id} | — |
get-custom-fields-by-object-key | read | GET | /custom-fields/object-key/{objectKey} | — |
custom-fields.delete-custom-field | admin, delete | DELETE | /custom-fields/{id} | — |
get-custom-field-by-id | read | GET | /custom-fields/{id} | — |
custom-fields.update-custom-field | admin, write | PUT | /custom-fields/{id} | — |
get-custom-menus | read | GET | /custom-menus/ | — |
create-custom-menu | admin, write | POST | /custom-menus/ | — |
delete-custom-menu | admin, delete | DELETE | /custom-menus/{customMenuId} | — |
get-custom-menu-by-id | read | GET | /custom-menus/{customMenuId} | — |
update-custom-menu | admin, write | PUT | /custom-menus/{customMenuId} | — |
verify-email | payment, write | POST | /email/verify | — |
list-bulk-action-campaigns | read | GET | /emails/locations/{locationId}/campaigns/bulk-actions | — |
get-bulk-action-campaign | read | GET | /emails/locations/{locationId}/campaigns/bulk-actions/{campaignId} | — |
list-email-campaigns | read | GET | /emails/locations/{locationId}/campaigns/emails | — |
create-email-campaign | write | POST | /emails/locations/{locationId}/campaigns/emails | — |
delete-campaign | delete | DELETE | /emails/locations/{locationId}/campaigns/emails/{campaignId} | — |
get-email-campaign | read | GET | /emails/locations/{locationId}/campaigns/emails/{campaignId} | — |
update-email-campaign | send, write | PATCH | /emails/locations/{locationId}/campaigns/emails/{campaignId} | — |
schedule-campaign | send, write | POST | /emails/locations/{locationId}/campaigns/emails/{campaignId}/schedule | — |
get-campaign-stats | read | GET | /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId} | — |
list-workflow-campaigns | read | GET | /emails/locations/{locationId}/campaigns/workflows | — |
get-workflow-campaign | read | GET | /emails/locations/{locationId}/campaigns/workflows/{campaignId} | — |
list-email-templates | read | GET | /emails/locations/{locationId}/templates | — |
create-email-template | write | POST | /emails/locations/{locationId}/templates | — |
create-template-folder | write | POST | /emails/locations/{locationId}/templates/folders | — |
import-email-template | write | POST | /emails/locations/{locationId}/templates/import | — |
delete-email-template | delete | DELETE | /emails/locations/{locationId}/templates/{templateId} | — |
get-email-template | read | GET | /emails/locations/{locationId}/templates/{templateId} | — |
update-email-template | write | PATCH | /emails/locations/{locationId}/templates/{templateId} | — |
get-forms | read | GET | /forms/ | — |
get-forms-submissions | read | GET | /forms/submissions | — |
upload-to-custom-fields | write | POST | /forms/upload-custom-files | — |
getFunnels | read | GET | /funnels/funnel/list | — |
create-redirect | admin, write | POST | /funnels/lookup/redirect | — |
fetch-redirects-list | read | GET | /funnels/lookup/redirect/list | — |
delete-redirect-by-id | admin, delete | DELETE | /funnels/lookup/redirect/{id} | — |
update-redirect-by-id | admin, write | PATCH | /funnels/lookup/redirect/{id} | — |
getPagesByFunnelId | read | GET | /funnels/page | — |
getPagesCountByFunnelId | read | GET | /funnels/page/count | — |
invoices.list-invoices | read | GET | /invoices/ | — |
create-invoice | payment, write | POST | /invoices/ | — |
create-new-estimate | payment, send, write | POST | /invoices/estimate | — |
list-estimates | read | GET | /invoices/estimate/list | — |
generate-estimate-number | read | GET | /invoices/estimate/number/generate | — |
update-estimate-last-visited-at | write | PATCH | /invoices/estimate/stats/last-visited-at | — |
list-estimate-templates | read | GET | /invoices/estimate/template | — |
create-estimate-template | write | POST | /invoices/estimate/template | — |
preview-estimate-template | read | GET | /invoices/estimate/template/preview | — |
delete-estimate-template | delete | DELETE | /invoices/estimate/template/{templateId} | — |
update-estimate-template | write | PUT | /invoices/estimate/template/{templateId} | — |
delete-estimate | delete | DELETE | /invoices/estimate/{estimateId} | — |
update-estimate | payment, send, write | PUT | /invoices/estimate/{estimateId} | — |
create-invoice-from-estimate | payment, write | POST | /invoices/estimate/{estimateId}/invoice | — |
send-estimate | send, write | POST | /invoices/estimate/{estimateId}/send | — |
generate-invoice-number | read | GET | /invoices/generate-invoice-number | — |
list-invoice-schedules | read | GET | /invoices/schedule | — |
create-invoice-schedule | payment, write | POST | /invoices/schedule | — |
delete-invoice-schedule | delete, payment | DELETE | /invoices/schedule/{scheduleId} | — |
get-invoice-schedule | read | GET | /invoices/schedule/{scheduleId} | — |
update-invoice-schedule | payment, write | PUT | /invoices/schedule/{scheduleId} | — |
auto-payment-invoice-schedule | payment, write | POST | /invoices/schedule/{scheduleId}/auto-payment | — |
cancel-invoice-schedule | payment, write | POST | /invoices/schedule/{scheduleId}/cancel | — |
schedule-invoice-schedule | payment, send, write | POST | /invoices/schedule/{scheduleId}/schedule | — |
update-and-schedule-invoice-schedule | payment, send, write | POST | /invoices/schedule/{scheduleId}/updateAndSchedule | — |
get-invoice-settings | read | GET | /invoices/settings | — |
update-invoice-last-visited-at | write | PATCH | /invoices/stats/last-visited-at | — |
list-invoice-templates | read | GET | /invoices/template | — |
create-invoice-template | payment, write | POST | /invoices/template | — |
delete-invoice-template | delete | DELETE | /invoices/template/{templateId} | — |
get-invoice-template | read | GET | /invoices/template/{templateId} | — |
update-invoice-template | write | PUT | /invoices/template/{templateId} | — |
update-invoice-template-late-fees-configuration | payment, write | PATCH | /invoices/template/{templateId}/late-fees-configuration | — |
update-invoice-payment-methods-configuration | payment, write | PATCH | /invoices/template/{templateId}/payment-methods-configuration | — |
text2pay-invoice | payment, send, write | POST | /invoices/text2pay | — |
delete-invoice | delete, payment | DELETE | /invoices/{invoiceId} | — |
get-invoice | read | GET | /invoices/{invoiceId} | — |
update-invoice | payment, write | PUT | /invoices/{invoiceId} | — |
update-invoice-late-fees-configuration | payment, write | PATCH | /invoices/{invoiceId}/late-fees-configuration | — |
record-invoice | payment, write | POST | /invoices/{invoiceId}/record-payment | — |
send-invoice | payment, send, write | POST | /invoices/{invoiceId}/send | — |
void-invoice | payment, write | POST | /invoices/{invoiceId}/void | — |
listAllKnowledgeBasesPaginated | read | GET | /knowledge-bases/ | — |
createKnowledgeBase | write | POST | /knowledge-bases/ | — |
deleteTrainedUrlsForKnowledgeBase | delete | DELETE | /knowledge-bases/crawler | — |
getAllWebsiteUrlsDataByKnowledgeBase | read | GET | /knowledge-bases/crawler | — |
discoverWebsite | write | POST | /knowledge-bases/crawler | — |
getCrawlingStatusForLatestOperation | read | GET | /knowledge-bases/crawler/status | — |
trainDiscoveredUrls | write | POST | /knowledge-bases/crawler/train | — |
list | read | GET | /knowledge-bases/faqs | — |
create | write | POST | /knowledge-bases/faqs | — |
knowledge-base.delete | delete | DELETE | /knowledge-bases/faqs/{id} | — |
update | write | PUT | /knowledge-bases/faqs/{id} | — |
updateKnowledgeBase | write | PUT | /knowledge-bases/{id} | — |
deleteKnowledgeBase | delete | DELETE | /knowledge-bases/{knowledgeBaseId} | — |
getKnowledgeBaseById | read | GET | /knowledge-bases/{knowledgeBaseId} | — |
get-links | read | GET | /links/ | — |
create-link | write | POST | /links/ | — |
get-link-by-id | read | GET | /links/id/{linkId} | — |
search-trigger-links | read | GET | /links/search | — |
delete-link | delete | DELETE | /links/{linkId} | — |
update-link | write | PUT | /links/{linkId} | — |
create-location | admin, write | POST | /locations/ | — |
search-locations | read | GET | /locations/search | — |
delete-location | admin, delete | DELETE | /locations/{locationId} | — |
get-location | read | GET | /locations/{locationId} | — |
put-location | admin, write | PUT | /locations/{locationId} | — |
get-conversation-channel | read | GET | /locations/{locationId}/conversationChannels/{type} | — |
get-custom-fields | read | GET | /locations/{locationId}/customFields | — |
locations.create-custom-field | admin, write | POST | /locations/{locationId}/customFields | — |
upload-file-customFields | admin, write | POST | /locations/{locationId}/customFields/upload | — |
locations.delete-custom-field | admin, delete | DELETE | /locations/{locationId}/customFields/{id} | — |
get-custom-field | read | GET | /locations/{locationId}/customFields/{id} | — |
locations.update-custom-field | admin, write | PUT | /locations/{locationId}/customFields/{id} | — |
get-custom-values | read | GET | /locations/{locationId}/customValues | — |
create-custom-value | admin, write | POST | /locations/{locationId}/customValues | — |
delete-custom-value | admin, delete | DELETE | /locations/{locationId}/customValues/{id} | — |
get-custom-value | read | GET | /locations/{locationId}/customValues/{id} | — |
update-custom-value | admin, write | PUT | /locations/{locationId}/customValues/{id} | — |
get-location-permissions | read | GET | /locations/{locationId}/permissions | — |
update-location-permissions | admin, write | PUT | /locations/{locationId}/permissions | — |
create-recurring-task | write | POST | /locations/{locationId}/recurring-tasks | — |
delete-recurring-task | delete | DELETE | /locations/{locationId}/recurring-tasks/{id} | — |
get-recurring-task-by-id | read | GET | /locations/{locationId}/recurring-tasks/{id} | — |
update-recurring-task | write | PUT | /locations/{locationId}/recurring-tasks/{id} | — |
get-location-tags | read | GET | /locations/{locationId}/tags | — |
create-tag | write | POST | /locations/{locationId}/tags | — |
delete-tag | delete | DELETE | /locations/{locationId}/tags/{tagId} | — |
get-tag-by-id | read | GET | /locations/{locationId}/tags/{tagId} | — |
update-tag | write | PUT | /locations/{locationId}/tags/{tagId} | — |
task-search | read | POST | /locations/{locationId}/tasks/search | — |
GET-all-or-email-sms-templates | read | GET | /locations/{locationId}/templates | — |
DELETE-an-email-sms-template | delete | DELETE | /locations/{locationId}/templates/{id} | — |
get-timezones | read | GET | /locations/{locationId}/timezones | — |
uninstall-application | admin, delete | DELETE | /marketplace/app/{appId}/installations | — |
migrateConnection | admin, write | POST | /marketplace/external-auth/migration | — |
bulk-delete-media-objects | delete | PUT | /medias/delete-files | — |
fetch-media-content | read | GET | /medias/files | — |
create-media-folder | write | POST | /medias/folder | — |
bulk-update-media-objects | write | PUT | /medias/update-files | — |
upload-media-content | write | POST | /medias/upload-file | — |
delete-media-content | delete | DELETE | /medias/{id} | — |
update-media-object | write | POST | /medias/{id} | — |
get-location-access-token | admin, write | POST | /oauth/location-token | refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it); also served at /oauth/locationToken |
get-access-token | admin, write | POST | /oauth/token | refused by default: leaves the caller holding a provider credential (a credential_minting rule can allow it) |
get-object-by-location-id | read | GET | /objects/ | — |
create-custom-object-schema | admin, write | POST | /objects/ | — |
get-object-schema-by-key | read | GET | /objects/{key} | — |
update-custom-object | admin, write | PUT | /objects/{key} | — |
create-object-record | write | POST | /objects/{schemaKey}/records | — |
search-object-records | read | POST | /objects/{schemaKey}/records/search | — |
delete-object-record | delete | DELETE | /objects/{schemaKey}/records/{id} | — |
get-record-by-id | read | GET | /objects/{schemaKey}/records/{id} | — |
update-object-record | write | PUT | /objects/{schemaKey}/records/{id} | — |
create-opportunity | write | POST | /opportunities/ | — |
get-lost-reason | read | GET | /opportunities/lost-reason | — |
get-pipelines | read | GET | /opportunities/pipelines | — |
search-opportunity | read | GET | /opportunities/search | — |
search-opportunities-advanced | read | POST | /opportunities/search | — |
Upsert-opportunity | write | POST | /opportunities/upsert | — |
delete-opportunity | delete | DELETE | /opportunities/{id} | — |
get-opportunity | read | GET | /opportunities/{id} | — |
update-opportunity | write | PUT | /opportunities/{id} | — |
remove-followers-opportunity | delete | DELETE | /opportunities/{id}/followers | — |
add-followers-opportunity | write | POST | /opportunities/{id}/followers | — |
update-opportunity-status | write | PUT | /opportunities/{id}/status | — |
delete-coupon | delete, payment | DELETE | /payments/coupon | — |
get-coupon | read | GET | /payments/coupon | — |
create-coupon | payment, write | POST | /payments/coupon | — |
update-coupon | payment, write | PUT | /payments/coupon | — |
list-coupons | read | GET | /payments/coupon/list | — |
custom-provider-marketplace-app-update-capabilities | admin, payment, write | PUT | /payments/custom-provider/capabilities | — |
fetch-config | admin, read | GET | /payments/custom-provider/connect | — |
create-config | admin, payment, write | POST | /payments/custom-provider/connect | — |
disconnect-config | admin, payment, write | POST | /payments/custom-provider/disconnect | — |
delete-integration | admin, delete, payment | DELETE | /payments/custom-provider/provider | — |
create-integration | admin, payment, write | POST | /payments/custom-provider/provider | — |
list-integration-providers | read | GET | /payments/integrations/provider/whitelabel | — |
create-integration provider | admin, payment, write | POST | /payments/integrations/provider/whitelabel | — |
list-orders | read | GET | /payments/orders | — |
get-order-by-id | read | GET | /payments/orders/{orderId} | — |
list-order-fulfillment | read | GET | /payments/orders/{orderId}/fulfillments | — |
create-order-fulfillment | send, write | POST | /payments/orders/{orderId}/fulfillments | — |
list-order-notes | read | GET | /payments/orders/{orderId}/notes | — |
record-order-payment | payment, write | POST | /payments/orders/{orderId}/record-payment | — |
list-subscriptions | read | GET | /payments/subscriptions | — |
get-subscription-by-id | read | GET | /payments/subscriptions/{subscriptionId} | — |
list-transactions | read | GET | /payments/transactions | — |
get-transaction-by-id | read | GET | /payments/transactions/{transactionId} | — |
getNumberPoolList | read | GET | /phone-system/number-pools | — |
active-numbers | read | GET | /phone-system/numbers/location/{locationId} | — |
listAvailableNumbersForACountry | read | GET | /phone-system/numbers/location/{locationId}/available | — |
purchase-number-for-location | admin, payment, write | POST | /phone-system/numbers/location/{locationId}/purchase | — |
products.list-invoices | read | GET | /products/ | — |
create-product | write | POST | /products/ | — |
bulkUpdate | delete, payment, write | POST | /products/bulk-update | — |
bulkEdit | payment, write | POST | /products/bulk-update/edit | — |
get-product-collection | read | GET | /products/collections | — |
create-product-collection | write | POST | /products/collections | — |
delete-product-collection | delete | DELETE | /products/collections/{collectionId} | — |
get-product-collection-id | read | GET | /products/collections/{collectionId} | — |
update-product-collection | write | PUT | /products/collections/{collectionId} | — |
get-list-inventory | read | GET | /products/inventory | — |
update-inventory | write | POST | /products/inventory | — |
get-product-reviews | read | GET | /products/reviews | — |
bulk-update-product-review | send, write | POST | /products/reviews/bulk-update | — |
get-reviews-count | read | GET | /products/reviews/count | — |
delete-product-review | delete | DELETE | /products/reviews/{reviewId} | — |
update-product-review | send, write | PUT | /products/reviews/{reviewId} | — |
update-store-status | write | POST | /products/store/{storeId} | — |
update-display-priority | write | POST | /products/store/{storeId}/priority | — |
get-product-store-stats | read | GET | /products/store/{storeId}/stats | — |
delete-product-by-id | delete | DELETE | /products/{productId} | — |
get-product-by-id | read | GET | /products/{productId} | — |
update-product-by-id | payment, write | PUT | /products/{productId} | — |
list-prices-for-product | read | GET | /products/{productId}/price | — |
create-price-for-product | payment, write | POST | /products/{productId}/price | — |
delete-price-by-id-for-product | delete, payment | DELETE | /products/{productId}/price/{priceId} | — |
get-price-by-id-for-product | read | GET | /products/{productId}/price/{priceId} | — |
update-price-by-id-for-product | payment, write | PUT | /products/{productId}/price/{priceId} | — |
list-documents-contracts | read | GET | /proposals/document | — |
send-documents-contracts | send, write | POST | /proposals/document/send | — |
list-documents-contracts-templates | read | GET | /proposals/templates | — |
send-documents-contracts-template | send, write | POST | /proposals/templates/send | — |
get-agency-plans-deprecated | read | GET | /saas-api/public-api/agency-plans/{companyId} | — |
bulk-disable-saas-deprecated | admin, payment, write | POST | /saas-api/public-api/bulk-disable-saas/{companyId} | — |
bulk-enable-saas-deprecated | admin, payment, write | POST | /saas-api/public-api/bulk-enable-saas/{companyId} | — |
getLocationWalletBalance | read | GET | /saas-api/public-api/companies/{companyId}/locations/{locationId}/wallet-balance | — |
updateLocationWalletBalance | admin, payment, write | POST | /saas-api/public-api/companies/{companyId}/locations/{locationId}/wallet-balance/complimentary-credits | — |
enable-saas-location-deprecated | admin, payment, write | POST | /saas-api/public-api/enable-saas/{locationId} | — |
get-location-subscription-deprecated | read | GET | /saas-api/public-api/get-saas-subscription/{locationId} | — |
locations-deprecated | read | GET | /saas-api/public-api/locations | — |
pause-location-deprecated | admin, payment, write | POST | /saas-api/public-api/pause/{locationId} | — |
get-saas-locations-deprecated | read | GET | /saas-api/public-api/saas-locations/{companyId} | — |
get-saas-plan-deprecated | read | GET | /saas-api/public-api/saas-plan/{planId} | — |
update-rebilling-deprecated | admin, payment, write | POST | /saas-api/public-api/update-rebilling/{companyId} | — |
generate-payment-link-deprecated | admin, payment, write | PUT | /saas-api/public-api/update-saas-subscription/{locationId} | — |
get-agency-plans | read | GET | /saas/agency-plans/{companyId} | — |
allow-attach-rebilling | admin, payment, write | POST | /saas/allow-attach-rebilling/{locationId} | — |
bulk-disable-saas | admin, payment, write | POST | /saas/bulk-disable-saas/{companyId} | — |
bulk-enable-saas | admin, payment, write | POST | /saas/bulk-enable-saas/{companyId} | — |
enable-saas-location | admin, payment, write | POST | /saas/enable-saas/{locationId} | — |
get-location-subscription | read | GET | /saas/get-saas-subscription/{locationId} | — |
locations | read | GET | /saas/locations | — |
pause-location | admin, payment, write | POST | /saas/pause/{locationId} | — |
get-saas-locations | read | GET | /saas/saas-locations/{companyId} | — |
get-saas-plan | read | GET | /saas/saas-plan/{planId} | — |
update-rebilling | admin, payment, write | POST | /saas/update-rebilling/{companyId} | — |
generate-payment-link | admin, payment, write | PUT | /saas/update-saas-subscription/{locationId} | — |
get-custom-snapshots | read | GET | /snapshots/ | — |
create-snapshot-share-link | admin, write | POST | /snapshots/share/link | — |
get-snapshot-push | read | GET | /snapshots/snapshot-status/{snapshotId} | — |
get-latest-snapshot-push | read | GET | /snapshots/snapshot-status/{snapshotId}/location/{locationId} | — |
createQueue | send, write | POST | /social-media-posting/category/queues | — |
fetchAvailableCategories | read | GET | /social-media-posting/category/queues/available-categories | — |
fetchQueues | read | POST | /social-media-posting/category/queues/list | — |
fetchCalendarList | read | POST | /social-media-posting/category/queues/list/calendar | — |
deleteCurrentActivePostAndScheduleNext | delete, send | DELETE | /social-media-posting/category/queues/{postId}/active-post | — |
fetchQueueById | read | GET | /social-media-posting/category/queues/{queueId} | — |
updateQueue | send, write | PUT | /social-media-posting/category/queues/{queueId} | — |
createQueueItem | send, write | POST | /social-media-posting/category/queues/{queueId}/create/item | — |
fetchEditSessionCalendar | read | POST | /social-media-posting/category/queues/{queueId}/edit/calendar | — |
discardEditSession | write | POST | /social-media-posting/category/queues/{queueId}/edit/discard | — |
saveEditSession | send, write | POST | /social-media-posting/category/queues/{queueId}/edit/save | — |
startEditSession | write | POST | /social-media-posting/category/queues/{queueId}/edit/start | — |
fetchQueueItems | read | POST | /social-media-posting/category/queues/{queueId}/items | — |
deleteQueueItem | delete | DELETE | /social-media-posting/category/queues/{queueId}/items/{itemId} | — |
updateQueueItem | send, write | PUT | /social-media-posting/category/queues/{queueId}/items/{itemId} | — |
cloneQueueItem | send, write | POST | /social-media-posting/category/queues/{queueId}/items/{itemId}/clone | — |
resetQueueItem | send, write | PUT | /social-media-posting/category/queues/{queueId}/items/{itemId}/reset | — |
fetchSlots | read | POST | /social-media-posting/category/queues/{queueId}/slots | — |
create-comment | send, write | POST | /social-media-posting/comments/{platform} | — |
get-comment-list | read | POST | /social-media-posting/comments/{platform}/list | — |
delete-like | delete, send | DELETE | /social-media-posting/comments/{platform}/{id}/like | — |
create-like | send, write | POST | /social-media-posting/comments/{platform}/{id}/like | — |
get-oauth-accounts | read | GET | /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} | — |
attach-oauth-accounts | admin, write | POST | /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} | — |
start-oauth | read | GET | /social-media-posting/oauth/{platform}/start | — |
get-statistics | read | POST | /social-media-posting/statistics | — |
get-account | read | GET | /social-media-posting/{locationId}/accounts | — |
delete-account | admin, delete | DELETE | /social-media-posting/{locationId}/accounts/{id} | — |
get-categories-location-id | read | GET | /social-media-posting/{locationId}/categories | — |
get-categories-id | read | GET | /social-media-posting/{locationId}/categories/{id} | — |
get-upload-status | read | GET | /social-media-posting/{locationId}/csv | — |
upload-csv | write | POST | /social-media-posting/{locationId}/csv | — |
delete-csv-post | delete | DELETE | /social-media-posting/{locationId}/csv/{csvId}/post/{postId} | — |
delete-csv | delete | DELETE | /social-media-posting/{locationId}/csv/{id} | — |
get-csv-post | read | GET | /social-media-posting/{locationId}/csv/{id} | — |
start-csv-finalize | send, write | PATCH | /social-media-posting/{locationId}/csv/{id} | — |
create-post | send, write | POST | /social-media-posting/{locationId}/posts | — |
bulk-delete-social-planner-posts | delete | POST | /social-media-posting/{locationId}/posts/bulk-delete | — |
get-posts | read | POST | /social-media-posting/{locationId}/posts/list | — |
delete-post | delete | DELETE | /social-media-posting/{locationId}/posts/{id} | — |
get-post | read | GET | /social-media-posting/{locationId}/posts/{id} | — |
edit-post | send, write | PUT | /social-media-posting/{locationId}/posts/{id} | — |
set-accounts | admin, write | POST | /social-media-posting/{locationId}/set-accounts | — |
get-tags-location-id | read | GET | /social-media-posting/{locationId}/tags | — |
get-tags-by-ids | read | POST | /social-media-posting/{locationId}/tags/details | — |
list-shipping-carriers | read | GET | /store/shipping-carrier | — |
create-shipping-carrier | write | POST | /store/shipping-carrier | — |
delete-shipping-carrier | delete | DELETE | /store/shipping-carrier/{shippingCarrierId} | — |
get-shipping-carriers | read | GET | /store/shipping-carrier/{shippingCarrierId} | — |
update-shipping-carrier | write | PUT | /store/shipping-carrier/{shippingCarrierId} | — |
list-shipping-zones | read | GET | /store/shipping-zone | — |
create-shipping-zone | write | POST | /store/shipping-zone | — |
get-available-shipping-zones | read | POST | /store/shipping-zone/shipping-rates | — |
delete-shipping-zone | delete | DELETE | /store/shipping-zone/{shippingZoneId} | — |
get-shipping-zones | read | GET | /store/shipping-zone/{shippingZoneId} | — |
update-shipping-zone | write | PUT | /store/shipping-zone/{shippingZoneId} | — |
list-shipping-rates | read | GET | /store/shipping-zone/{shippingZoneId}/shipping-rate | — |
create-shipping-rate | payment, write | POST | /store/shipping-zone/{shippingZoneId}/shipping-rate | — |
delete-shipping-rate | delete, payment | DELETE | /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} | — |
get-shipping-rates | read | GET | /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} | — |
update-shipping-rate | payment, write | PUT | /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId} | — |
get-store-settings | read | GET | /store/store-setting | — |
create-store-setting | admin, write | POST | /store/store-setting | — |
get-surveys | read | GET | /surveys/ | — |
get-surveys-submissions | read | GET | /surveys/submissions | — |
create-user | admin, write | POST | /users/ | — |
search-users | read | GET | /users/search | — |
filter-users-by-email | read | POST | /users/search/filter-by-email | — |
delete-user | admin, delete | DELETE | /users/{userId} | — |
get-user | read | GET | /users/{userId} | — |
update-user | admin, write | PUT | /users/{userId} | — |
voice-ai.create-action | admin, write | POST | /voice-ai/actions | — |
voice-ai.delete-action | admin, delete | DELETE | /voice-ai/actions/{actionId} | — |
get-action | read | GET | /voice-ai/actions/{actionId} | — |
voice-ai.update-action | admin, write | PUT | /voice-ai/actions/{actionId} | — |
get-agents | read | GET | /voice-ai/agents | — |
voice-ai.create-agent | admin, write | POST | /voice-ai/agents | — |
voice-ai.delete-agent | admin, delete | DELETE | /voice-ai/agents/{agentId} | — |
voice-ai.get-agent | read | GET | /voice-ai/agents/{agentId} | — |
patch-agent | admin, write | PATCH | /voice-ai/agents/{agentId} | — |
get-call-logs | read | GET | /voice-ai/dashboard/call-logs | — |
getCallLog | read | GET | /voice-ai/dashboard/call-logs/{callId} | — |
get-workflow | read | GET | /workflows/ | — |