Integrations
HighLevel
Set up HighLevel (GoHighLevel) OAuth for CRM, messaging, and marketing automation
Overview
Section titled “Overview”Connect end users’ HighLevel sub-accounts and agencies for contacts, conversations, calendars, opportunities, invoices, and marketing automation. HighLevel was formerly called GoHighLevel; its API is served from services.leadconnectorhq.com.
This page covers a HighLevel Marketplace app (OAuth). To store a token a HighLevel account creates for itself, see HighLevel Private Integration Token.
| Property | Value |
|---|---|
| Provider ID | gohighlevel |
| Category | CRM |
| PKCE | Not supported |
| Token refresh | Automatic |
| Redirect URI | Shown in Developer Portal |
Step 1: Create a HighLevel Marketplace app
Section titled “Step 1: Create a HighLevel Marketplace app”Go to the HighLevel Marketplace
Sign in to the HighLevel Marketplace developer portal, open My Apps, and click Create App.
Choose the target user
Set Target User to Sub-account, HighLevel’s recommendation for most apps. It cannot be changed later. New apps can be bulk-installed by agencies, and that setting cannot be turned off, so an agency user who connects the app gives an agency-level token while a sub-account user gives a sub-account token (see The connected account).
Add the redirect URL
Under Advanced Settings → Auth, paste the Alter callback URL from the Developer Portal into Redirect URL and click Add.
Select scopes
On the same Auth page, open Select Scope and choose the scopes the application needs. Select the same scopes in Alter in Step 2.
Get credentials
On the same Auth page, under Client Keys, click Add, name the key pair, and copy the Client ID and Client Secret. HighLevel shows the secret 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 provider
Go to OAuth Providers > Add Provider > HighLevel.
Enter credentials
- Client ID: the HighLevel app’s Client ID
- Client Secret: the HighLevel app’s Client Secret
Select scopes
Choose the same scopes you selected on the HighLevel app.
Save
Click Save. The provider is now active.
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 access 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"},)A call without Version, a call that needs a scope the connection lacks, and an agency token calling a sub-account API all come back from HighLevel as 401. Alter returns these to the caller as HighLevel’s response and does not treat them as a revoked connection; only a rejected access token marks the connection for reconnect.
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.
The connected account
Section titled “The connected account”Who connects the app decides the kind of token, and therefore the connected account:
- A sub-account user gives a sub-account (Location) token, bound to that sub-account. Alter records the connection as
location:<locationId>, with thelocationIdas its account identifier. - An agency user gives an agency (Company) token. Alter records the connection as
company:<companyId>, with thecompanyIdas its account identifier. Agency APIs (such as creating a sub-account) take this token directly; sub-account APIs refuse it.
HighLevel’s way to reach a sub-account from an agency token, POST /oauth/location-token (/oauth/locationToken in earlier API versions), returns a new HighLevel access token and refresh token to the caller. Alter always refuses it through the proxy, together with the token exchange POST /oauth/token, because an agent holding those tokens would act outside Alter’s storage, policy, and revocation. To call a sub-account’s APIs, have a user of that sub-account connect it.
Reconnecting the same sub-account or agency reuses its connection.
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 the HighLevel provider configuration. Content rules can name a HighLevel operation from the table below, a family, or a request field:
| Family | HighLevel operations it covers |
|---|---|
read | Every GET, plus the read-only POST searches and lookups (contacts, opportunities, object records, tasks, users by email, Social Planner lists and statistics, shipping-rate quotes, keyword ideas, calendar-group slug validation) |
write | Every create and update |
delete | Every DELETE, plus bulk deletion of social posts and media files, the bulk product update (its type can delete products), and the bulk contact tag update (it can remove tags) |
send | Calls that themselves deliver something to a person: sending a conversation message, review replies (Google and product reviews), live-chat typing, adding a contact to a campaign or workflow, scheduling or editing an email campaign, sending invoices and estimates (including saving an estimate with sendEstimateDetails), order fulfillments (notifyCustomer), sending documents for signature, booking, rescheduling, or cancelling appointments and service bookings, Social Planner posts, comments, likes, and publishing queues, blog posts, publishing or resuming ads (including Google and LinkedIn campaign upserts, which can publish, LinkedIn ad status changes, and LinkedIn lead forms), and running an AI agent |
payment | Writes that bill, charge, or change what anyone pays: invoices (create, update, delete, void, send, record payment), estimates (which can auto-invoice), recurring invoice schedules and auto-payment, invoice templates and their late-fee and payment-method settings, order payments, coupons, product prices (including a product update that changes them) and the bulk product update, service and calendar payment settings, shipping rates, wallet charges, billed email verification, payment providers, SaaS subscriptions and rebilling, phone-number purchases, and ad campaigns, budgets, and audiences |
admin | Sub-accounts and their permissions, custom fields and values, users, custom menus, chat widgets, snapshots, app installations, OAuth tokens, SaaS configuration, payment providers (including reading the stored payment-provider keys), the phone system, Conversation AI and Voice AI agents, AI Agent Studio agent definitions and promotion, store settings, who is notified about bookings (calendar notification settings and the notification fields of a calendar), the social accounts Social Planner publishes to, funnel redirects, custom-object schemas, and association definitions |
send covers what a call delivers itself. Any HighLevel write can also start a workflow the sub-account has configured: the usual triggers are adding or removing a contact tag (POST /contacts/{contactId}/tags, DELETE /contacts/{contactId}/tags, POST /contacts/bulk/tags/update/{type}), creating or updating a contact (POST /contacts/, POST /contacts/upsert, PUT /contacts/{contactId}), moving an opportunity (PUT /opportunities/{id}, PUT /opportunities/{id}/status), and recording an inbound message (POST /conversations/messages/inbound). Those are write; to require approval for them, name the operations in the rule.
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.
Sending a conversation message, an invoice, or an estimate projects a recipients parameter that folds every address and number the request names (emailTo, emailCc, emailBcc, toNumber, and the forwarding address for a message; sentTo and the contact details for an invoice or estimate), so a rule such as “require approval when recipients fall outside @example.com” judges them. A message also reaches people the request does not name unless it names its destination: an Email goes to the contact’s own address unless emailTo is set, an SMS, RCS, or WhatsApp message to the contact’s own number unless toNumber is set, and other types to the contact’s channel identity; a reply_all reaches every participant in the thread; a forward can name its recipient by contact or conversation id. In those cases the recipients cannot be judged, and any rule that names recipients refuses the message. Sending a document for signature delivers to the recipients stored on the document, so it projects no recipients and a rule that names them refuses it.
HighLevel scopes are a second, separate check. Alter records the granted scopes on every connection, and a grant can be narrowed to some of them — for example contacts.readonly for one agent. Alter then refuses any call that needs a scope outside the narrowed set with insufficient_scope, before the call reaches HighLevel. A call must pass both policy and scopes. A narrowed grant also refuses, with scope_narrowing_unenforceable, every call whose scope Alter cannot determine:
- 94 of HighLevel’s 627 operations name no scope in HighLevel’s API reference or scopes page, or name one HighLevel does not grant to apps (for example knowledge bases, brand voices, recurring tasks, SaaS routes, and the media and invoice-template settings routes).
alter policy simulateand Explain a request show when a request’s scope cannot be determined. - A few paths match two operations equally well (for example
/calendars/resources/free-slots, which is both a calendar resource type and a calendar’s free slots). - Some scopes in the table below cover only HighLevel endpoints its v3 API reference does not document (the
workflows.*,emails/builder.*,emails/schedule.readonly,saas/location.*, andsocialplanner/oauth.*scopes), so a grant narrowed to them can call no cataloged operation.
To let a narrowed grant make such a call, attach a method and endpoint restriction that pins it to the grant or agent.
Use alter policy simulate or Explain a request in the Developer Portal to see which operation, family, and scope a HighLevel request classifies as. See Policies and Set policies.
- Access tokens last about 24 hours. Refresh tokens are single-use and valid for a year; Alter refreshes and stores the replacement automatically.
- HighLevel has no token revocation endpoint. Disconnecting in Alter removes Alter’s copy of the tokens; uninstall the app in HighLevel to cut off its access there.
- HighLevel’s burst limit is 100 requests per 10 seconds, and its daily limit 200,000 requests, per app per sub-account or agency.
- 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.
- See the HighLevel OAuth documentation for more details.
Available Scopes
Section titled “Available Scopes”The scopes a HighLevel app can request: every scope on HighLevel’s scopes reference, and the scopes its v3 API reference names for an operation that HighLevel’s authorization server also lists. Scopes marked Requested by default are requested when a connection names no scopes.
| Scope | Description |
|---|---|
adPublishing.readonly | View adPublishing (Sub-Account). Used by: Get Facebook integration; Get Facebook pages; Get Google ad accounts |
adPublishing.write | Manage adPublishing (Sub-Account). Used by: Add custom audience member; Batch update audience members; Create Facebook integration |
affiliate-manager.readonly | View affiliate manager. Used by: Get Affiliate; List Affiliates; List Commissions |
agent-studio.readonly | View agent studio. Used by: Get Agent; Get Agent (Deprecated); List Agents |
agent-studio.write | Manage agent studio. Used by: Create Agent; Delete Agent; Execute Agent |
associations.readonly | View associations (Sub-Account). Used by: Get all associations for a sub-account / location; Get association by ID; Get association by object keys |
associations.write | Manage associations (Sub-Account). Used by: Create Association; Delete Association; Update Association By Id |
associations/relation.readonly | View associations relation (Sub-Account). Used by: Get all relations By record Id |
associations/relation.write | Manage associations relation (Sub-Account). Used by: Create Relation for you associated entities.; Delete Relation |
blogs/author.readonly | View blogs author (Sub-Account). Used by: Get all authors |
blogs/category.readonly | View blogs category (Sub-Account). Used by: Get all categories |
blogs/check-slug.readonly | View blogs check slug (Sub-Account). Used by: Check url slug |
blogs/list.readonly | View blogs list (Sub-Account). Used by: Get Blogs by Location ID |
blogs/post-update.write | Manage blogs post update (Sub-Account). Used by: Update Blog Post |
blogs/post.write | Manage blogs post (Sub-Account). Used by: Create Blog Post |
blogs/posts.readonly | View blogs posts (Sub-Account). Used by: Get Blog posts by Blog ID |
brand-boards/design-kit.readonly | View brand boards design kit. Used by: Get Brand Board; Get Brand Boards |
brand-boards/design-kit.write | Manage brand boards design kit. Used by: Create a new brand board; Delete a Brand Board; Update a Brand Board |
businesses.readonly | View businesses (Sub-Account). Used by: Get Business; Get Businesses by Location |
businesses.write | Manage businesses (Sub-Account). Used by: Create Business; Delete Business; Update Business |
calendars.readonly | View calendars (Sub-Account). Used by: Get Calendar; Get Calendars; Get Free Slots |
calendars.write | Manage calendars (Sub-Account). Used by: Apply user availability schedule to a calendar; Create Calendar; Create Service |
calendars/events.readonly | View calendars events (Sub-Account). Used by: Get Appointment; Get Blocked Slots; Get Calendar Events |
calendars/events.write | Manage calendars events (Sub-Account). Used by: Create Block Slot; Create Note; Create Service Booking |
calendars/groups.readonly | View calendars groups (Sub-Account). Used by: Get Groups |
calendars/groups.write | Manage calendars groups (Sub-Account). Used by: Create Calendar Group; Delete Group; Disable Group |
calendars/resources.readonly | View calendars resources (Sub-Account). Used by: Get Calendar Resource; List Calendar Resources |
calendars/resources.write | Manage calendars resources (Sub-Account). Used by: Create Calendar Resource; Delete Calendar Resource; Update Calendar Resource |
campaigns.readonly | View campaigns (Sub-Account). Used by: Get Campaigns |
charges.readonly | View charges (Sub-Account). Used by: Check if account has sufficient funds; Get all wallet charges; Get specific wallet charge details |
charges.write | Manage charges (Sub-Account). Used by: Create a new wallet charge; Delete a wallet charge |
chat-widget.readonly | View chat widget. Used by: Get Chat Widget; List Chat Widgets |
chat-widget.write | Manage chat widget. Used by: Clone Chat Widget; Create Chat Widget; Delete Chat Widget |
companies.readonly | View companies (Agency). Used by: Get Company |
contacts.readonly | Requested by default. View contacts (Sub-Account). Used by: Get All Notes; Get Appointments for Contact; Get Contact |
contacts.write | Manage contacts (Sub-Account). Used by: Add Contact to Campaign; Add Contact to Workflow; Add Followers |
conversation-ai.readonly | View conversation ai. Used by: Get Action by ID; Get Agent; Get the generation details |
conversation-ai.write | Manage conversation ai. Used by: Attach Action to Agent; Create an Agent; Delete Agent |
conversations.readonly | View conversations (Sub-Account). Used by: Get Conversation; Search Conversations |
conversations.write | Manage conversations (Sub-Account). Used by: Create Conversation; Delete Conversation; Update Conversation |
conversations/livechat.write | Manage conversations livechat. Used by: Agent/Ai-Bot is typing a message indicator for live chat |
conversations/message.readonly | View conversations message (Sub-Account). Used by: Download transcription by Message ID; Export messages by location ID; Get Recording by Message ID |
conversations/message.write | Manage conversations message (Sub-Account). Used by: Add an external outbound call; Add an inbound message; Add message attachments |
courses.write | Manage courses (Sub-Account). Used by: Import Courses |
custom-menu-link.readonly | View custom menu link (Agency). Used by: Get Custom Menu Link; Get Custom Menu Links |
custom-menu-link.write | Manage custom menu link (Agency). Used by: Create Custom Menu Link; Delete Custom Menu Link; Update Custom Menu Link |
documents_contracts/list.readonly | View documents contracts list (Sub-Account, Agency). Used by: List documents |
documents_contracts/sendLink.write | Manage documents contracts sendLink (Sub-Account, Agency). Used by: Send document |
documents_contracts_template/list.readonly | View documents contracts template list (Sub-Account, Agency). Used by: List templates |
documents_contracts_template/sendLink.write | Manage documents contracts template sendLink (Sub-Account, Agency). Used by: Send template |
emails/builder.readonly | View emails builder (Sub-Account) |
emails/builder.write | Manage emails builder (Sub-Account) |
emails/campaigns.readonly | View emails campaigns. Used by: Get Bulk Action Campaign by ID; Get Email Campaign by ID; Get Workflow Campaign by ID |
emails/campaigns.write | Manage emails campaigns. Used by: Create Email Campaign; Delete Campaign; Schedule Campaign |
emails/schedule.readonly | View emails schedule (Sub-Account) |
emails/stats.readonly | View emails stats. Used by: Get Campaign Statistics |
emails/templates.readonly | View emails templates. Used by: Get Email Template by ID; List templates |
emails/templates.write | Manage emails templates. Used by: Create a template folder; Create an email template; Delete a template |
forms.readonly | View forms (Sub-Account). Used by: Get Forms; Get Forms Submissions |
forms.write | Manage forms (Sub-Account). Used by: Upload files to custom fields |
funnels/funnel.readonly | View funnels funnel (Sub-Account). Used by: Fetch List of Funnels |
funnels/page.readonly | View funnels page (Sub-Account). Used by: Fetch list of funnel pages |
funnels/pagecount.readonly | View funnels pagecount (Sub-Account). Used by: Fetch count of funnel pages |
funnels/redirect.readonly | View funnels redirect (Sub-Account). Used by: Fetch List of Redirects |
funnels/redirect.write | Manage funnels redirect (Sub-Account). Used by: Create Redirect; Delete Redirect By Id; Update Redirect By Id |
invoices.readonly | View invoices (Sub-Account). Used by: Generate Invoice Number; Get Invoice Settings; Get invoice |
invoices.write | Manage invoices (Sub-Account). Used by: Create & Send; Create Invoice; Delete invoice |
invoices/estimate.readonly | View invoices estimate (Sub-Account). Used by: Generate Estimate Number; List Estimate Templates; List Estimates |
invoices/estimate.write | Manage invoices estimate (Sub-Account). Used by: Create Estimate Template; Create Invoice from Estimate; Create New Estimate |
invoices/schedule.readonly | View invoices schedule (Sub-Account). Used by: Get an schedule; List schedules |
invoices/schedule.write | Manage invoices schedule (Sub-Account). Used by: Cancel an scheduled invoice; Create Invoice Schedule; Delete schedule |
invoices/template.readonly | View invoices template (Sub-Account). Used by: Get an template; List templates |
invoices/template.write | Manage invoices template (Sub-Account). Used by: Create template; Delete template; Update template |
lc-email.readonly | View lc email. Used by: Email Verification |
links.readonly | View links (Sub-Account). Used by: Get Link by ID; Get Links; Search Trigger Links |
links.write | Manage links (Sub-Account). Used by: Create Link; Delete Link; Update Link |
locations.readonly | Requested by default. View locations (Sub-Account, Agency). Used by: Fetch Timezones; Get Conversation Channel; Get Sub-Account (Formerly Location) |
locations.write | Manage locations (Agency). Used by: Create Sub-Account (Formerly Location); Put Sub-Account (Formerly Location) |
locations/customFields.readonly | View locations customFields (Sub-Account). Used by: Get Custom Field; Get Custom Field / Folder By Id; Get Custom Fields |
locations/customFields.write | Manage locations customFields (Sub-Account). Used by: Create Custom Field; Create Custom Field Folder; Delete Custom Field |
locations/customValues.readonly | View locations customValues (Sub-Account). Used by: Get Custom Value; Get Custom Values |
locations/customValues.write | Manage locations customValues (Sub-Account). Used by: Create Custom Value; Delete Custom Value; Update Custom Value |
locations/tags.readonly | View locations tags (Sub-Account). Used by: Get Tags; Get tag by id |
locations/tags.write | Manage locations tags (Sub-Account). Used by: Create Tag; Delete tag; Update tag |
locations/tasks.readonly | View locations tasks (Sub-Account). Used by: Task Search Filter |
locations/templates.readonly | View locations templates (Sub-Account). Used by: GET all or email/sms templates |
marketplace-installer-details.readonly | View marketplace installer details (Sub-Account, Agency). Used by: Get Installer Details |
medias.readonly | View medias (Sub-Account). Used by: Get List of Files/ Folders |
medias.write | Manage medias (Sub-Account). Used by: Delete File or Folder; Upload File into Media Storage |
numberpools.read | View numberpools (Sub-Account). Used by: List number pools |
oauth.readonly | View oauth (Agency). Used by: Get Location where app is installed; Get rebilling config for an app subscription and usage plans |
oauth.write | Manage oauth (Agency, Sub-Account). Used by: Get Location Access Token from Agency Token; Uninstall an application |
objects/record.readonly | View objects record (Sub-Account). Used by: Get Record By Id; Search Object Records |
objects/record.write | Manage objects record (Sub-Account). Used by: Create Record; Delete Record; Update Record |
objects/schema.readonly | View objects schema (Sub-Account). Used by: Get Object Schema by key / id; Get all objects for a location |
objects/schema.write | Manage objects schema (Sub-Account). Used by: Create Custom Object; Update Object Schema By Key / Id |
opportunities.readonly | View opportunities (Sub-Account). Used by: Get Opportunity; Get Pipelines; Get lost reason |
opportunities.write | Manage opportunities (Sub-Account). Used by: Add Followers; Create Opportunity; Delete Opportunity |
payments/coupons.readonly | View payments coupons (Sub-Account). Used by: Fetch Coupon; List Coupons |
payments/coupons.write | Manage payments coupons (Sub-Account). Used by: Create Coupon; Delete Coupon; Update Coupon |
payments/custom-provider.readonly | View payments custom provider (Sub-Account). Used by: Fetch given provider config |
payments/custom-provider.write | Manage payments custom provider (Sub-Account). Used by: Create new integration; Create new provider config; Custom-provider marketplace app update capabilities |
payments/integration.readonly | View payments integration (Sub-Account). Used by: List White-label Integration Providers |
payments/integration.write | Manage payments integration (Sub-Account). Used by: Create White-label Integration Provider |
payments/orders.collectPayment | Payments orders: collectPayment. Used by: Record Order Payment |
payments/orders.readonly | View payments orders (Sub-Account). Used by: Get Order by ID; List Orders; List fulfillment |
payments/orders.write | Manage payments orders (Sub-Account). Used by: Create order fulfillment |
payments/subscriptions.readonly | View payments subscriptions (Sub-Account). Used by: Get Subscription by ID; List Subscriptions |
payments/transactions.readonly | View payments transactions (Sub-Account). Used by: Get Transaction by ID; List Transactions |
phonenumbers.read | View phonenumbers (Sub-Account). Used by: List active numbers; List available phone numbers |
phonenumbers.write | Manage phonenumbers. Used by: Purchase number for location |
products.readonly | View products (Sub-Account). Used by: Fetch Product Reviews; Fetch Product Store Stats; Fetch Review Count as per status |
products.write | Manage products (Sub-Account). Used by: Action to include/exclude the product in store; Bulk Update Products; Create Product |
products/collection.readonly | View products collection (Sub-Account). Used by: Fetch Product Collections; Get Details about individual product collection |
products/collection.write | Manage products collection (Sub-Account). Used by: Create Product Collection; Delete Product Collection; Update Product Collection |
products/prices.readonly | View products prices (Sub-Account). Used by: Get Price by ID for a Product; List Inventory; List Prices for a Product |
products/prices.write | Manage products prices (Sub-Account). Used by: Create Price for a Product; Delete Price by ID for a Product; Update Inventory |
saas/company.write | Manage saas company (Sub-Account, Agency). Used by: Update Location Wallet Balance |
saas/location.read | View saas location (Sub-Account, Agency) |
saas/location.write | Manage saas location (Agency, Sub-Account) |
snapshots.readonly | View snapshots (Agency). Used by: Get Last Snapshot Push; Get Snapshot Push between Dates; Get Snapshots |
snapshots.write | Manage snapshots (Agency). Used by: Create Snapshot Share Link |
socialplanner/account.readonly | View socialplanner account (Sub-Account). Used by: Get Accounts |
socialplanner/account.write | Manage socialplanner account (Sub-Account). Used by: Delete Account |
socialplanner/category.readonly | View socialplanner category (Sub-Account). Used by: Fetch a category queue by ID; Fetch calendar view for an edit session; Fetch category queues for a location |
socialplanner/category.write | Manage socialplanner category. Used by: Clone a queue item; Create a new category queue; Create a new item in the queue |
socialplanner/csv.readonly | View socialplanner csv (Sub-Account). Used by: Get CSV Post; Get Upload Status |
socialplanner/csv.write | Manage socialplanner csv (Sub-Account). Used by: Delete CSV; Delete CSV Post; Set Accounts |
socialplanner/oauth.readonly | View socialplanner oauth (Sub-Account) |
socialplanner/oauth.write | Manage socialplanner oauth (Sub-Account) |
socialplanner/post.readonly | View socialplanner post (Sub-Account). Used by: Get post; Get posts |
socialplanner/post.write | Manage socialplanner post (Sub-Account). Used by: Create post; Delete Post; Edit post |
socialplanner/statistics.readonly | View socialplanner statistics (Sub-Account). Used by: Get Social Media Statistics |
socialplanner/tag.readonly | View socialplanner tag (Sub-Account). Used by: Get tags by ids; Get tags by location id |
surveys.readonly | View surveys (Sub-Account). Used by: Get Surveys; Get Surveys Submissions |
users.readonly | View users (Sub-Account, Agency). Used by: Filter Users by Email; Get User; Search Users |
users.write | Manage users (Sub-Account, Agency). Used by: Create User; Delete User; Update User |
voice-ai-agent-goals.readonly | View voice ai agent goals (Sub-Account). Used by: Get Agent Action |
voice-ai-agent-goals.write | Manage voice ai agent goals (Sub-Account). Used by: Create Agent Action; Delete Agent Action; Update Agent Action |
voice-ai-agents.readonly | View voice ai agents (Sub-Account). Used by: Get Agent; List Agents |
voice-ai-agents.write | Manage voice ai agents (Sub-Account). Used by: Create Agent; Delete Agent; Patch Agent |
voice-ai-dashboard.readonly | View voice ai dashboard (Sub-Account). Used by: Get Call Log; List Call Logs |
workflows.delete | Delete workflows (Sub-Account) |
workflows.logs | Workflows: logs (Sub-Account) |
workflows.publish | Workflows: publish (Sub-Account) |
workflows.readonly | View workflows (Sub-Account). Used by: Get Workflow |
workflows.write | Manage workflows (Sub-Account) |
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 | — |
get-installer-details | read | GET | /marketplace/app/{appId}/installations | — |
get-rebilling-config-for-app | read | GET | /marketplace/app/{appId}/rebilling-config/location/{locationId} | — |
getCharges | read | GET | /marketplace/billing/charges | — |
charge | payment, write | POST | /marketplace/billing/charges | — |
hasFunds | read | GET | /marketplace/billing/charges/has-funds | — |
deleteCharge | delete, payment | DELETE | /marketplace/billing/charges/{chargeId} | — |
getSpecificCharge | read | GET | /marketplace/billing/charges/{chargeId} | — |
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-installed-location | read | GET | /oauth/installed-locations | also served at /oauth/installedLocations |
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/ | — |