HighLevel

Delete ad account: Remove a Facebook ad account connection from a location (DELETE /ad-publishing/facebook/ad-accounts/{adAccountId})

Delete ad: Delete a Facebook ad by ID (DELETE /ad-publishing/facebook/ads/{adId})

Delete ad set: Delete a Facebook ad set by ID (DELETE /ad-publishing/facebook/adsets/{adsetId})

Delete campaign: Delete a Facebook campaign by ID (DELETE /ad-publishing/facebook/campaigns/{campaignId})

Delete custom audience: Delete a Facebook custom audience by ID (DELETE /ad-publishing/facebook/custom-audience/{audienceId})

Remove custom audience member: Remove a member from a Facebook custom audience (DELETE /ad-publishing/facebook/custom-audience/{audienceId}/member)

Delete Facebook integration: Remove the Facebook ad integration from a location (DELETE /ad-publishing/facebook/integration)

Delete page connection: Remove a Facebook page connection from a location (DELETE /ad-publishing/facebook/page)

Delete ad account: Remove a Google Ads account connection from a location (DELETE /ad-publishing/google/ad-accounts/{adAccountId})

Delete conversion: Delete a Google Ads conversion action by ID (DELETE /ad-publishing/google/conversions/{conversionId})

Delete segment: Delete a Google Ads audience segment by ID (DELETE /ad-publishing/google/segments/{segmentId})

Delete ad account: Remove a LinkedIn ad account connection from a location (DELETE /ad-publishing/linkedin/ad-account)

Delete Agent: Deletes an agent and all its versions. (DELETE /agent-studio/agent/{agentId})

Delete Association: Delete USER_DEFINED Association By Id, deleting an association will also all the relations for that association (DELETE /associations/{associationId})

Delete Relation (DELETE /associations/relations/{relationId})

Delete a Brand Board: Deletes a Brand Board (DELETE /brand-boards/{locationId}/{id})

Delete Business (DELETE /businesses/{businessId})

Delete Note (DELETE /calendars/appointments/{appointmentId}/notes/{noteId})

Delete Calendar: Delete calendar by ID (DELETE /calendars/{calendarId})

Delete Notification: Delete notification (DELETE /calendars/{calendarId}/notifications/{notificationId})

Delete Event: Delete event by ID (DELETE /calendars/events/{eventId})

Delete Group (DELETE /calendars/groups/{groupId})

Delete Calendar Resource: Delete calendar resource by ID (DELETE /calendars/resources/{resourceType}/{id})

Delete user availability schedule: Permanently remove a schedule and all its associated rules. This action cannot be undone. (DELETE /calendars/schedules/{id})

Remove user availability schedule from a calendar: Removes the association between a team calendar and the given schedule by removing the calendarId from the schedule (DELETE /calendars/schedules/{id}/associations/{calendarId})

Delete Contact (DELETE /contacts/{contactId})

Remove Contact From Campaign (DELETE /contacts/{contactId}/campaigns/{campaignId})

Remove Contact From Every Campaign (DELETE /contacts/{contactId}/campaigns/removeAll)

Remove Followers (DELETE /contacts/{contactId}/followers)

Delete Note (DELETE /contacts/{contactId}/notes/{id})

Remove Tags (DELETE /contacts/{contactId}/tags)

Delete Task (DELETE /contacts/{contactId}/tasks/{taskId})

Delete Contact from Workflow (DELETE /contacts/{contactId}/workflow/{workflowId})

Delete Agent: Deletes an AI agent permanently. This action cannot be undone. All associated configurations and conversation history will be removed. (DELETE /conversation-ai/agents/{agentId})

Remove Action from Agent: Permanently deletes an action. This will remove the action from all associated agents and cannot be undone. (DELETE /conversation-ai/agents/{agentId}/actions/{actionId})

Delete Conversation: Delete the conversation details based on the conversation ID (DELETE /conversations/{conversationId})

Cancel a scheduled message.: Post the messageId for the API to delete a scheduled message. (DELETE /conversations/messages/{messageId}/schedule)

Cancel a scheduled email message.: Post the messageId for the API to delete a scheduled email message. (DELETE /conversations/messages/email/{emailMessageId}/schedule)

Delete Custom Field By Id: Delete Custom Field By Id ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (DELETE /custom-fields/{id})

Delete Custom Field Folder: Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (DELETE /custom-fields/folder/{id})

Delete Custom Menu Link: Removes a specific custom menu from the system. This operation requires authentication and proper permissions. The custom menu is identified by its unique ID, and the operation is performed within the context of a specific company. (DELETE /custom-menus/{customMenuId})

Delete a template (DELETE /emails/builder/{locationId}/{templateId})

Delete Redirect By Id: The "Delete Redirect By Id" API Allows deletion of a URL redirect from the system using its unique identifier. Use this endpoint to delete a URL redirect with the specified ID using details provided in the request payload. (DELETE /funnels/lookup/redirect/{id})

Delete invoice: API to delete invoice by invoice id (DELETE /invoices/{invoiceId})

Delete Estimate: Delete an existing estimate (DELETE /invoices/estimate/{estimateId})

Delete Estimate Template: Delete an existing estimate template (DELETE /invoices/estimate/template/{templateId})

Delete schedule: API to delete an schedule by schedule id (DELETE /invoices/schedule/{scheduleId})

Delete template: API to update an template by template id (DELETE /invoices/template/{templateId})

Delete a knowledge base (DELETE /knowledge-bases/{knowledgeBaseId})

Delete trained pages (DELETE /knowledge-bases/crawler)

Delete an existing knowledge base FAQ (DELETE /knowledge-bases/faqs/{id})

Delete Link (DELETE /links/{linkId})

Delete Custom Field (DELETE /locations/{locationId}/customFields/{id})

Delete Custom Value (DELETE /locations/{locationId}/customValues/{id})

Delete Recurring Task (DELETE /locations/{locationId}/recurring-tasks/{id})

Delete tag (DELETE /locations/{locationId}/tags/{tagId})

DELETE an email/sms template (DELETE /locations/{locationId}/templates/{id})

Uninstall an application: Uninstalls an application from your company or a specific location. This will remove the applications access and stop all its functionalities (DELETE /marketplace/app/{appId}/installations)

Delete a wallet charge (DELETE /marketplace/billing/charges/{chargeId})

Delete File or Folder: Deletes specific file or folder from the media storage (DELETE /medias/{id})

Delete Record: Delete Record By Id . Supported Objects are business and custom objects. (DELETE /objects/{schemaKey}/records/{id})

Delete Opportunity (DELETE /opportunities/{id})

Remove Followers: Allows removal of one or all followers from an opportunity. (DELETE /opportunities/{id}/followers)

Delete Coupon: The "Delete Coupon" API allows you to permanently remove a coupon from your system using its unique identifier. Use this endpoint to discontinue promotional offers or clean up unused coupons. Note that this action cannot be undone. (DELETE /payments/coupon)

Deleting an existing integration: API to delete an association for an app and location (DELETE /payments/custom-provider/provider)

Delete Product by ID: The "Delete Product by ID" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system. (DELETE /products/{productId})

Delete Price by ID for a Product: The "Delete Price by ID for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system. (DELETE /products/{productId}/price/{priceId})

Delete Product Collection: Delete specific product collection with Id :collectionId (DELETE /products/collections/{collectionId})

Delete Product Review: Delete specific product review (DELETE /products/reviews/{reviewId})

Delete Account: Delete account and account from group (DELETE /social-media-posting/{locationId}/accounts/{id})

Delete CSV Post (DELETE /social-media-posting/{locationId}/csv/{csvId}/post/{postId})

Delete CSV (DELETE /social-media-posting/{locationId}/csv/{id})

Delete Post (DELETE /social-media-posting/{locationId}/posts/{id})

Delete shipping carrier: Delete specific shipping carrier with Id :shippingCarrierId (DELETE /store/shipping-carrier/{shippingCarrierId})

Delete shipping zone: Delete specific shipping zone with Id :shippingZoneId (DELETE /store/shipping-zone/{shippingZoneId})

Delete shipping rate: Delete specific shipping rate with Id :shippingRateId (DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId})

Delete User (DELETE /users/{userId})

Delete Agent Action: Delete an existing action from a voice AI agent. This permanently removes the action and its configuration. (DELETE /voice-ai/actions/{actionId})

Delete Agent: Delete a voice AI agent and all its configurations (DELETE /voice-ai/agents/{agentId})

Get ad accounts: Retrieve Facebook ad accounts available for the connected user (GET /ad-publishing/facebook/ad-accounts)

Get ad account details: Retrieve details of a specific Facebook ad account (GET /ad-publishing/facebook/ad-accounts/{adAccountId})

Get campaign with linked entities: Retrieve a Facebook campaign with its linked adsets and ads (GET /ad-publishing/facebook/campaign/{campaignId})

Get conversation forms: Retrieve Facebook conversation lead forms for a location (GET /ad-publishing/facebook/conversation-forms)

Get custom audiences: Retrieve Facebook custom audiences for a location (GET /ad-publishing/facebook/custom-audience)

Get custom audience by ID: Retrieve a specific Facebook custom audience by its ID (GET /ad-publishing/facebook/custom-audience/{audienceId})

Get entities: Retrieve Facebook campaigns, adsets, or ads based on entity type (GET /ad-publishing/facebook/entity)

Get Facebook integration: Retrieve the Facebook ad integration details for a location (GET /ad-publishing/facebook/integration)

Get lead form by ID: Retrieve a specific Facebook lead form by its ID (GET /ad-publishing/facebook/lead-form/{leadFormId})

Get current Facebook user: Retrieve the authenticated Facebook user profile for a location (GET /ad-publishing/facebook/me)

Get page lead forms: Retrieve lead gen forms for a specific Facebook page (GET /ad-publishing/facebook/page/{pageId}/forms)

Get Instagram accounts for page: Retrieve Instagram accounts linked to a specific Facebook page (GET /ad-publishing/facebook/page/{pageId}/instagram)

Get Facebook pages: Retrieve Facebook pages associated with the connected account (GET /ad-publishing/facebook/pages)

Get conversion pixels: Retrieve Facebook conversion pixels for a location (GET /ad-publishing/facebook/pixels)

Get reporting data: Retrieve aggregated Facebook ad reporting metrics for a location (GET /ad-publishing/facebook/reporting)

Get campaign reporting: Retrieve reporting metrics for a specific Facebook campaign (GET /ad-publishing/facebook/reporting/campaign/{campaignId})

Get reporting list: Retrieve a list of Facebook campaigns, adsets, or ads with reporting data (GET /ad-publishing/facebook/reporting/list)

Search targeting options: Search Facebook geo-locations and interests for ad targeting (GET /ad-publishing/facebook/targeting/search)

Get Google ad accounts: Retrieve Google Ads accounts available for the connected user (GET /ad-publishing/google/ad-accounts)

Get ad account details: Retrieve details of a specific Google Ads account (GET /ad-publishing/google/ad-accounts/{adAccountId})

Get Google campaign by ID: Retrieve a specific Google Ads campaign by ID (GET /ad-publishing/google/ads/{adId})

Get assets: Retrieve Google Ads creative assets for a location (GET /ad-publishing/google/assets)

Get audiences: Retrieve Google Ads combined audiences for a location (GET /ad-publishing/google/audiences)

Get audience by ID: Retrieve a specific Google Ads combined audience by ID (GET /ad-publishing/google/audiences/{audienceId})

Get conversion goals: Retrieve Google Ads conversion goals for a location (GET /ad-publishing/google/conversion-goals)

Get conversions: Retrieve Google Ads conversion actions for a location (GET /ad-publishing/google/conversions)

Get conversion by ID: Retrieve a specific Google Ads conversion action by ID (GET /ad-publishing/google/conversions/{conversionId})

Get entities: Retrieve Google campaigns, ad groups, or ads based on entity type (GET /ad-publishing/google/entity)

Get Google integration: Retrieve the Google Ads integration details for a location (GET /ad-publishing/google/integration)

Get current Google user: Retrieve the authenticated Google user info for a location (GET /ad-publishing/google/me)

Get reporting data: Retrieve aggregated Google Ads reporting metrics for a location (GET /ad-publishing/google/reporting)

Get campaign reporting: Retrieve reporting metrics for a specific Google campaign (GET /ad-publishing/google/reporting/campaign/{campaignId})

Get reporting list: Retrieve a list of Google campaigns or ad groups with reporting data (GET /ad-publishing/google/reporting/list)

Get segments: Retrieve Google Ads audience segments for a location (GET /ad-publishing/google/segments)

Get segment by ID: Retrieve a specific Google Ads audience segment by ID (GET /ad-publishing/google/segments/{segmentId})

Get target interests: Retrieve affinity and in-market audience options for Google Ads targeting (GET /ad-publishing/google/target-interests)

Search targeting options: Search Google geo-locations for ad targeting (GET /ad-publishing/google/targeting/search)

Get ad account details: Retrieve details of a specific LinkedIn ad account (GET /ad-publishing/linkedin/ad-account)

Get LinkedIn ad accounts: Retrieve LinkedIn Ads accounts available for the connected user (GET /ad-publishing/linkedin/ad-accounts)

Get ad campaign group: Retrieve a LinkedIn ad campaign group by ID (GET /ad-publishing/linkedin/ads/{adId})

Get lead forms: Retrieve LinkedIn lead gen forms for an ad account (GET /ad-publishing/linkedin/{accountId}/forms)

Get LinkedIn integration: Retrieve the LinkedIn Ads integration details for a location (GET /ad-publishing/linkedin/integration)

Get current LinkedIn user: Retrieve the authenticated LinkedIn user info for a location (GET /ad-publishing/linkedin/me)

Get ad analytics: Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping (GET /ad-publishing/linkedin/reporting)

Get campaign group reporting: Retrieve reporting metrics for a specific LinkedIn campaign group (GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId})

Get reporting list: Retrieve a list of LinkedIn campaigns or campaign groups with reporting data (GET /ad-publishing/linkedin/reporting/list)

Search targeting options: Search LinkedIn targeting facets such as locations, industries, and job titles (GET /ad-publishing/linkedin/targeting/search)

List Affiliates: Retrieve the list of affiliates for a location. (GET /affiliate-manager/{locationId}/affiliates)

Get Affiliate: Retrieve a single affiliate by id for a location. (GET /affiliate-manager/{locationId}/affiliates/{affiliateId})

List Commissions: Retrieve the list of commissions for a location. (GET /affiliate-manager/{locationId}/commissions)

List Payouts: Retrieve the list of payouts for a location. (GET /affiliate-manager/{locationId}/payouts)

List Agents: Lists all active agents for the specified location. locationId is required parameter to ensure optimal performance. Supports pagination using limit and offset. Optionally filter by isPublished=true to return only agents with a published... (GET /agent-studio/agent)

Get Agent: Gets a specific agent by its ID for the specified location with all its versions. Returns complete agent metadata and all non-deleted versions (draft, staging, production). locationId is required parameter. The agent must have active... (GET /agent-studio/agent/{agentId})

List Agents (Deprecated): **Deprecated endpoint - use GET /agent instead.** Lists all active agents that have a published production version for the specified location. locationId is required parameter. Supports pagination using limit and offset. (GET /agent-studio/public-api/agents)

Get Agent (Deprecated): **Deprecated endpoint - use GET /agent/:agentId instead.** Gets a specific agent by its ID for the specified location with all its versions. locationId is required parameter. The agent must have active status. (GET /agent-studio/public-api/agents/{agentId})

Get all associations for a sub-account / location: Get all Associations (GET /associations)

Get association by ID: Using this api you can get SYSTEM_DEFINED / USER_DEFINED association by id (GET /associations/{associationId})

Get association key by key name: Using this api you can get standard / user defined association by key (GET /associations/key/{key_name})

Get association by object keys: Get association by object keys like contacts, custom objects and opportunities. (GET /associations/objectKey/{objectKey})

Get all relations By record Id: Get all relations by record Id (GET /associations/relations/{recordId})

Get all authors: The "Get all authors" Api return the blog authors for a given location ID. Please use "blogs/author.readonly" (GET /blogs/authors)

Get all categories: The "Get all categories" Api return the blog categoies for a given location ID. Please use "blogs/category.readonly" (GET /blogs/categories)

Get Blog posts by Blog ID: The "Get Blog posts by Blog ID" API allows you get blog posts for any given blog site using blog ID.Please use blogs/posts.readonly (GET /blogs/posts/all)

Check url slug: The "Check url slug" API allows check the blog slug validation which is needed before publishing any blog post. Please use blogs/check-slug.readonly. you can find the POST ID from the post edit url. (GET /blogs/posts/url-slug-exists)

Get Blogs by Location ID: The "Get Blogs by Location ID" API allows you get blogs using Location ID.Please use blogs/list.readonly (GET /blogs/site/all)

Get Brand Boards: Retrieves all Brand Boards for a specific location (GET /brand-boards/{locationId})

Get Brand Board: Retrieves a specific Brand Board by its ID (GET /brand-boards/{locationId}/{id})

Get Businesses by Location (GET /businesses)

Get Business (GET /businesses/{businessId})

Get Calendars: Get all calendars in a location. (GET /calendars)

Get Notes: Get Appointment Notes (GET /calendars/appointments/{appointmentId}/notes)

Get Blocked Slots (GET /calendars/blocked-slots)

Get Calendar: Get calendar by ID (GET /calendars/{calendarId})

Get Free Slots: Get free slots for a calendar between a date range. Optionally a consumer can also request free slots in a particular timezone and also for a particular user. (GET /calendars/{calendarId}/free-slots)

Get notifications: Get calendar notifications based on query (GET /calendars/{calendarId}/notifications)

Get notification: Find Event notification by notificationId (GET /calendars/{calendarId}/notifications/{notificationId})

Get Calendar Events (GET /calendars/events)

Get Appointment: Get appointment by ID (GET /calendars/events/appointments/{eventId})

Get Groups: Get all calendar groups in a location. (GET /calendars/groups)

List Calendar Resources: List calendar resources by resource type and location ID (GET /calendars/resources/{resourceType})

Get Calendar Resource: Get calendar resource by ID (GET /calendars/resources/{resourceType}/{id})

Get user availability schedule: Retrieve a specific schedule by its unique identifier. Returns detailed information including rules, timezone, and associated calendars/users. (GET /calendars/schedules/{id})

List user availability schedule: Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination. (GET /calendars/schedules/search)

Get Campaigns (GET /campaigns)

Get Company: Get Comapny (GET /companies/{companyId})

Get Contacts: Get Contacts **Note:** This API endpoint is deprecated. Please use the Search Contacts endpoint instead. (GET /contacts)

Get Contacts By BusinessId (GET /contacts/business/{businessId})

Get Contact (GET /contacts/{contactId})

Get Appointments for Contact (GET /contacts/{contactId}/appointments)

Get All Notes (GET /contacts/{contactId}/notes)

Get Note (GET /contacts/{contactId}/notes/{id})

Get all Tasks (GET /contacts/{contactId}/tasks)

Get Task (GET /contacts/{contactId}/tasks/{taskId})

Get Duplicate Contact: Get Duplicate Contact. If Allow Duplicate Contact is disabled under Settings, the global unique identifier will be used for searching the contact. If the setting is enabled, first priority for search is email and the second priority will... (GET /contacts/search/duplicate)

Get Agent: Retrieves a specific AI agent by its ID. Returns the complete agent configuration including name, status, actions, and settings. (GET /conversation-ai/agents/{agentId})

Get Action by ID: Retrieves detailed information about a specific action using its unique identifier. Returns the action configuration, associated agents, and performance metrics. (GET /conversation-ai/agents/{agentId}/actions/{actionId})

List Actions for an Agent: List for actions for an agent (GET /conversation-ai/agents/{agentId}/actions/list)

Search Agents: Searches for AI agents based on various criteria including name, status, and configuration. Supports advanced filtering and full-text search capabilities. (GET /conversation-ai/agents/search)

Get the generation details: Retrieves detailed information about AI responses including the System Prompt, Conversation history, Knowledge base, website, FAQ chunks, and Rich Text chunks. (GET /conversation-ai/generations)

Get Conversation: Get the conversation details based on the conversation ID (GET /conversations/{conversationId})

Get messages by conversation id: Get messages by conversation id. (GET /conversations/{conversationId}/messages)

Get transcription by Message ID: Get the recording transcription for a message by passing the message id (GET /conversations/locations/{locationId}/messages/{messageId}/transcription)

Download transcription by Message ID: Download the recording transcription for a message by passing the message id (GET /conversations/locations/{locationId}/messages/{messageId}/transcription/download)

Get message by message id: Get message by message id. (GET /conversations/messages/{id})

Get Recording by Message ID: Get the recording for a message by passing the message id (GET /conversations/messages/{messageId}/locations/{locationId}/recording)

Get email by Id (GET /conversations/messages/email/{id})

Export messages by location ID: Export messages for a specific location with cursor-based pagination support. Response includes messageType (string), source, and subType fields. The channel parameter is optional - if not provided, all non-email message types will be... (GET /conversations/messages/export)

Get All Custom Subtypes: Get all custom subtypes for a location (GET /conversations/preferences/custom-subtypes)

Get Contact Unsubscription Status: Get all subscription statuses for a contact (all emails or specific email) (GET /conversations/preferences/unsubscriptions/status)

Search Conversations: Returns a list of all conversations matching the search criteria along with the sort and filter options selected. (GET /conversations/search)

Get Custom Field / Folder By Id: Get Custom Field / Folder By Id. ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (GET /custom-fields/{id})

Get Custom Fields By Object Key: Get Custom Fields By Object Key ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (GET /custom-fields/object-key/{objectKey})

Get Custom Menu Links: Fetches a collection of custom menus based on specified criteria. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata. The response can be tailored using... (GET /custom-menus)

Get Custom Menu Link: Fetches a single custom menus based on id. This endpoint allows clients to retrieve custom menu configurations, which may include menu items, categories, and associated metadata (GET /custom-menus/{customMenuId})

Fetch email templates: Fetch email templates by location id (GET /emails/builder)

Get Campaigns (GET /emails/schedule)

Get Forms (GET /forms)

Get Forms Submissions (GET /forms/submissions)

Fetch List of Funnels: Retrieves a list of all funnels based on the given query parameters. (GET /funnels/funnel/list)

Fetch List of Redirects: Retrieves a list of all URL redirects based on the given query parameters. (GET /funnels/lookup/redirect/list)

Fetch list of funnel pages: Retrieves a list of all funnel pages based on the given query parameters. (GET /funnels/page)

Fetch count of funnel pages: Retrieves count of all funnel pages based on the given query parameters. (GET /funnels/page/count)

List invoices: API to get list of invoices (GET /invoices)

Get invoice: API to get invoice by invoice id (GET /invoices/{invoiceId})

List Estimates: Get a paginated list of estimates (GET /invoices/estimate/list)

Generate Estimate Number: Get the next estimate number for the given location (GET /invoices/estimate/number/generate)

List Estimate Templates: Get a list of estimate templates or a specific template by ID (GET /invoices/estimate/template)

Preview Estimate Template: Get a preview of an estimate template (GET /invoices/estimate/template/preview)

Generate Invoice Number: Get the next invoice number for the given location (GET /invoices/generate-invoice-number)

List schedules: API to get list of schedules (GET /invoices/schedule)

Get an schedule: API to get an schedule by schedule id (GET /invoices/schedule/{scheduleId})

Get Invoice Settings: Get the invoice settings for the given location (GET /invoices/settings)

List templates: API to get list of templates (GET /invoices/template)

Get an template: API to get an template by template id (GET /invoices/template/{templateId})

Get all knowledge bases for a location by location Id (paginated) (GET /knowledge-bases)

Get knowledge base by ID (GET /knowledge-bases/{knowledgeBaseId})

Get all trained page links by knowledge base (GET /knowledge-bases/crawler)

Get crawling status for the latest operation (GET /knowledge-bases/crawler/status)

Get all FAQs by knowledge base with pagination support: Retrieves FAQs for a knowledge base. Supports pagination using limit and lastFaqId parameters. (GET /knowledge-bases/faqs)

Get Links (GET /links)

Get Link by ID: Get a single link by its ID (GET /links/id/{linkId})

Search Trigger Links: Get list of links by searching (GET /links/search)

Get Sub-Account (Formerly Location): Get details of a Sub-Account (Formerly Location) by passing the sub-account id (GET /locations/{locationId})

Get Custom Fields (GET /locations/{locationId}/customFields)

Get Custom Field (GET /locations/{locationId}/customFields/{id})

Get Custom Values (GET /locations/{locationId}/customValues)

Get Custom Value (GET /locations/{locationId}/customValues/{id})

Get Recurring Task By Id (GET /locations/{locationId}/recurring-tasks/{id})

Get Tags: Get Sub-Account (Formerly Location) Tags (GET /locations/{locationId}/tags)

Get tag by id (GET /locations/{locationId}/tags/{tagId})

GET all or email/sms templates (GET /locations/{locationId}/templates)

Fetch Timezones: Fetch the available timezones (GET /locations/{locationId}/timezones)

Search: Search Sub-Account (Formerly Location) (GET /locations/search)

Get Installer Details: Fetches installer details for the authenticated user. This endpoint returns information about the company, location, user, and installation details associated with the current OAuth token. (GET /marketplace/app/{appId}/installations)

Get rebilling config for an app subscription and usage plans: Get rebilling config for an app subscription and usage plans for the authenticated sub-account. This endpoint returns the subscription and usage plans for an app. (GET /marketplace/app/{appId}/rebilling-config/location/{locationId})

Get all wallet charges (GET /marketplace/billing/charges)

Get specific wallet charge details (GET /marketplace/billing/charges/{chargeId})

Check if account has sufficient funds (GET /marketplace/billing/charges/has-funds)

Get List of Files/ Folders: Fetches list of files and folders from the media storage (GET /medias/files)

Get Location where app is installed: This API allows you fetch location where app is installed upon (GET /oauth/installedLocations)

Get all objects for a location: Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here :... (GET /objects)

Get Object Schema by key / id: Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records,... (GET /objects/{key})

Get Record By Id: Allows you to get a Standard Object like business and custom object record by Id (GET /objects/{schemaKey}/records/{id})

Get Opportunity (GET /opportunities/{id})

Get lost reason (GET /opportunities/lost-reason)

Get Pipelines (GET /opportunities/pipelines)

Search Opportunity (GET /opportunities/search)

Fetch Coupon: The "Get Coupon Details" API enables you to retrieve comprehensive information about a specific coupon using either its unique identifier or promotional code. Use this endpoint to view coupon parameters, usage statistics, validity periods,... (GET /payments/coupon)

List Coupons: The "List Coupons" API allows you to retrieve a list of all coupons available in your location. Use this endpoint to view all promotional offers and special discounts for your customers. (GET /payments/coupon/list)

Fetch given provider config: API for fetching an existing payment config for given location (GET /payments/custom-provider/connect)

List White-label Integration Providers: The "List White-label Integration Providers" API allows to retrieve a paginated list of integration providers. Customize your results by filtering whitelabel integration providers(which are built directly on top of Authorize.net or NMI)... (GET /payments/integrations/provider/whitelabel)

List Orders: The "List Orders" API allows to retrieve a paginated list of orders. Customize your results by filtering orders based on name, alt type, order status, payment mode, date range, type of source, contact, funnel products or paginate through... (GET /payments/orders)

Get Order by ID: The "Get Order by ID" API allows to retrieve information for a specific order using its unique identifier. Use this endpoint to fetch details for a single order based on the provided order ID. (GET /payments/orders/{orderId})

List fulfillment: List all fulfillment history of an order (GET /payments/orders/{orderId}/fulfillments)

List Order Notes: List all notes of an order (GET /payments/orders/{orderId}/notes)

List Subscriptions: The "List Subscriptions" API allows to retrieve a paginated list of subscriptions. Customize your results by filtering subscriptions based on name, alt type, subscription status, payment mode, date range, type of source, contact,... (GET /payments/subscriptions)

Get Subscription by ID: The "Get Subscription by ID" API allows to retrieve information for a specific subscription using its unique identifier. Use this endpoint to fetch details for a single subscription based on the provided subscription ID. (GET /payments/subscriptions/{subscriptionId})

List Transactions: The "List Transactions" API allows to retrieve a paginated list of transactions. Customize your results by filtering transactions based on name, alt type, transaction status, payment mode, date range, type of source, contact, subscription... (GET /payments/transactions)

Get Transaction by ID: The "Get Transaction by ID" API allows to retrieve information for a specific transaction using its unique identifier. Use this endpoint to fetch details for a single transaction based on the provided transaction ID. (GET /payments/transactions/{transactionId})

List Number Pools: Get list of number pools (GET /phone-system/number-pools)

List active numbers: Retrieve a paginated list of active phone numbers for a specific location. Supports filtering, pagination, and optional exclusion of number pool assignments. (GET /phone-system/numbers/location/{locationId})

List available phone numbers: Search for available phone numbers to purchase for a specific location. Supports filtering by number pattern, type, and capabilities. (GET /phone-system/numbers/location/{locationId}/available)

List Products: The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward... (GET /products)

Get Product by ID: The "Get Product by ID" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product ID. (GET /products/{productId})

List Prices for a Product: The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters. (GET /products/{productId}/price)

Get Price by ID for a Product: The "Get Price by ID for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price... (GET /products/{productId}/price/{priceId})

Fetch Product Collections: Internal API to fetch the Product Collections (GET /products/collections)

Get Details about individual product collection (GET /products/collections/{collectionId})

List Inventory: The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters. (GET /products/inventory)

Fetch Product Reviews: API to fetch the Product Reviews (GET /products/reviews)

Fetch Review Count as per status: API to fetch the Review Count as per status (GET /products/reviews/count)

Fetch Product Store Stats: API to fetch the total number of products, included in the store, and excluded from the store and other stats (GET /products/store/{storeId}/stats)

List documents: List documents for a location (GET /proposals/document)

List templates: List document contract templates for a location (GET /proposals/templates)

Get Agency Plans: Fetch all agency subscription plans for a given company ID (GET /saas/agency-plans/{companyId})

Get Agency Plans: Fetch all agency subscription plans for a given company ID (GET /saas-api/public-api/agency-plans/{companyId})

Get Location Subscription Details: Fetch subscription details for a specific location from location metadata (GET /saas-api/public-api/get-saas-subscription/{locationId})

Get locations by stripeId with companyId: Get locations by stripeCustomerId or stripeSubscriptionId with companyId (GET /saas-api/public-api/locations)

Get SaaS Locations: Fetch all SaaS-activated locations for a company with pagination (GET /saas-api/public-api/saas-locations/{companyId})

Get SaaS Plan: Fetch a specific SaaS plan by plan ID (GET /saas-api/public-api/saas-plan/{planId})

Get Location Subscription Details: Fetch subscription details for a specific location from location metadata (GET /saas/get-saas-subscription/{locationId})

Get locations by stripeId with companyId: Get locations by stripeCustomerId or stripeSubscriptionId with companyId (GET /saas/locations)

Get SaaS Locations: Fetch all SaaS-activated locations for a company with pagination (GET /saas/saas-locations/{companyId})

Get SaaS Plan: Fetch a specific SaaS plan by plan ID (GET /saas/saas-plan/{planId})

Get Snapshots: Get a list of all own and imported Snapshots (GET /snapshots)

Get Snapshot Push between Dates: Get list of sub-accounts snapshot pushed in time period (GET /snapshots/snapshot-status/{snapshotId})

Get Last Snapshot Push: Get Latest Snapshot Push Status for a location id (GET /snapshots/snapshot-status/{snapshotId}/location/{locationId})

Get Accounts: Get list of accounts and groups (GET /social-media-posting/{locationId}/accounts)

Get categories by location id (GET /social-media-posting/{locationId}/categories)

Get categories by id (GET /social-media-posting/{locationId}/categories/{id})

Get Upload Status (GET /social-media-posting/{locationId}/csv)

Get CSV Post (GET /social-media-posting/{locationId}/csv/{id})

Get post (GET /social-media-posting/{locationId}/posts/{id})

Get tags by location id (GET /social-media-posting/{locationId}/tags)

Get facebook pages (GET /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId})

Get google business locations (GET /social-media-posting/oauth/{locationId}/google/locations/{accountId})

Get Instagram Professional Accounts (GET /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId})

Get Linkedin pages and profile (GET /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId})

Get Tiktok profile (GET /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId})

Get Tiktok Business profile (GET /social-media-posting/oauth/{locationId}/tiktok-business/accounts/{accountId})

Get Twitter profile: ! As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience. (GET /social-media-posting/oauth/{locationId}/twitter/accounts/{accountId})

Starts OAuth For Facebook Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Facebook login OAuth screen. On successful login, listen on window object for message where event listener returns data in its... (GET /social-media-posting/oauth/facebook/start)

Starts OAuth For Google Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Google login OAuth screen. On successful login, listen on window object for message where event listener returns data in its... (GET /social-media-posting/oauth/google/start)

Starts OAuth For Instagram Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Instagram login OAuth screen. On successful login, listen on window object for message where event listener returns data in its... (GET /social-media-posting/oauth/instagram/start)

Starts OAuth For LinkedIn Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to LinkedIn login OAuth screen. On successful login, listen on window object for message where event listener returns data in its... (GET /social-media-posting/oauth/linkedin/start)

Starts OAuth For Tiktok Business Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Tiktok-Business login OAuth screen. On successful login, listen on window object for message where event listener returns data in... (GET /social-media-posting/oauth/tiktok-business/start)

Starts OAuth For Tiktok Account: Open the API in a window with appropriate params and headers instead of using the Curl. User is navigated to Tiktok login OAuth screen. On successful login, listen on window object for message where event listener returns data in its... (GET /social-media-posting/oauth/tiktok/start)

Starts OAuth For Twitter Account: ! As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience. (GET /social-media-posting/oauth/twitter/start)

List Shipping Carriers: The "List Shipping Carrier" API allows to retrieve a list of shipping carrier. (GET /store/shipping-carrier)

Get Shipping Carrier: The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier. (GET /store/shipping-carrier/{shippingCarrierId})

List Shipping Zones: The "List Shipping Zone" API allows to retrieve a list of shipping zone. (GET /store/shipping-zone)

Get Shipping Zone: The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone. (GET /store/shipping-zone/{shippingZoneId})

List Shipping Rates: The "List Shipping Rate" API allows to retrieve a list of shipping rate. (GET /store/shipping-zone/{shippingZoneId}/shipping-rate)

Get Shipping Rate: The "List Shipping Rate" API allows to retrieve a paginated list of shipping rate. (GET /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId})

Get Store Settings: Get store settings by altId and altType. (GET /store/store-setting)

Get Surveys (GET /surveys)

Get Surveys Submissions (GET /surveys/submissions)

Get User by Location: Deprecated. Use GET /users/search instead. Pass locationId as a query parameter to filter results by location, along with the required companyId and other search filters as needed. (GET /users)

Get User (GET /users/{userId})

Search Users (GET /users/search)

Get Agent Action: Retrieve details of a specific action by its ID. Returns the action configuration including actionParameters. (GET /voice-ai/actions/{actionId})

List Agents: Retrieve a paginated list of agents for given location. (GET /voice-ai/agents)

Get Agent: Retrieve detailed configuration and settings for a specific voice AI agent (GET /voice-ai/agents/{agentId})

List Call Logs: Returns call logs for Voice AI agents scoped to a location. Supports filtering by agent, contact, call type, action types, and date range (interpreted in the provided IANA timezone). Also supports sorting and 1-based pagination. (GET /voice-ai/dashboard/call-logs)

Get Call Log: Returns a call log by callId. (GET /voice-ai/dashboard/call-logs/{callId})

Get Workflow (GET /workflows)

Update ad status: Pause or resume a LinkedIn ad, campaign, or ad group (PATCH /ad-publishing/linkedin/{adId}/status)

Update Agent Metadata: Updates agent metadata such as name, description, and status. (PATCH /agent-studio/agent/{agentId})

Update Agent: Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration. (PATCH /agent-studio/agent/versions/{versionId})

Update a Brand Board: Updates an existing Brand Board (PATCH /brand-boards/{locationId}/{id})

Update Followup Settings: Update the followup settings for an action (PATCH /conversation-ai/agents/{agentId}/followup-settings)

Update Redirect By Id: The "Update Redirect By Id" API Allows updating an existing URL redirect in the system. Use this endpoint to modify a URL redirect with the specified ID using details provided in the request payload. (PATCH /funnels/lookup/redirect/{id})

Update invoice late fees configuration: API to update invoice late fees configuration by invoice id (PATCH /invoices/{invoiceId}/late-fees-configuration)

Update estimate last visited at: API to update estimate last visited at by estimate id (PATCH /invoices/estimate/stats/last-visited-at)

Update invoice last visited at: API to update invoice last visited at by invoice id (PATCH /invoices/stats/last-visited-at)

Update template late fees configuration: API to update template late fees configuration by template id (PATCH /invoices/template/{templateId}/late-fees-configuration)

Update template late fees configuration: API to update template late fees configuration by template id (PATCH /invoices/template/{templateId}/payment-methods-configuration)

Start CSV Finalize (PATCH /social-media-posting/{locationId}/csv/{id})

Patch Agent: Partially update an existing voice AI agent (PATCH /voice-ai/agents/{agentId})

Duplicate ad: Duplicate an existing Facebook ad (POST /ad-publishing/facebook/ads/{adId}/duplicate)

Pause ad: Pause a running Facebook ad (POST /ad-publishing/facebook/ads/{adId}/pause)

Resume ad: Resume a paused Facebook ad (POST /ad-publishing/facebook/ads/{adId}/resume)

Duplicate ad set: Duplicate an existing Facebook ad set (POST /ad-publishing/facebook/adsets/{adsetId}/duplicate)

Pause ad set: Pause a running Facebook ad set (POST /ad-publishing/facebook/adsets/{adsetId}/pause)

Resume ad set: Resume a paused Facebook ad set (POST /ad-publishing/facebook/adsets/{adsetId}/resume)

Duplicate campaign: Duplicate an existing Facebook campaign (POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate)

Pause campaign: Pause a running Facebook campaign (POST /ad-publishing/facebook/campaigns/{campaignId}/pause)

Publish campaign: Publish a Facebook campaign and push it live to Facebook (POST /ad-publishing/facebook/campaigns/{campaignId}/publish)

Resume campaign: Resume a paused Facebook campaign (POST /ad-publishing/facebook/campaigns/{campaignId}/resume)

Create conversation form: Create a new Facebook conversation lead form (POST /ad-publishing/facebook/conversation-forms)

Create Facebook integration: Create a Facebook ad integration for a location with page and ad account (POST /ad-publishing/facebook/integration)

Create page lead form: Create a new lead gen form on a Facebook page (POST /ad-publishing/facebook/page/{pageId}/forms)

Publish ad: Publish a Google ad and push it live (POST /ad-publishing/google/ads/{adId}/publish)

Upsert assets: Create or update Google Ads creative assets (POST /ad-publishing/google/assets)

Create Google integration: Create a Google Ads integration for a location (POST /ad-publishing/google/integration)

Get keyword ideas: Retrieve keyword suggestions for Google Ads campaigns (POST /ad-publishing/google/keyword-ideas)

Create offline user list job: Create a job to upload users to a Google customer match list (POST /ad-publishing/google/segments/offline-user-list-job)

Publish ad campaign group: Publish a LinkedIn ad campaign group and push it live (POST /ad-publishing/linkedin/ads/{adId}/publish)

Create lead form: Create a new LinkedIn lead gen form for an ad account (POST /ad-publishing/linkedin/{accountId}/form)

Create LinkedIn integration: Create a LinkedIn Ads integration for a location with ad account details (POST /ad-publishing/linkedin/integration)

Create Agent: Creates a new agent with staging version. The agent will be created with an initial staging version that can later be promoted to production. (POST /agent-studio/agent)

Execute Agent: Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified location. locationId is required in the request body. **Session... (POST /agent-studio/agent/{agentId}/execute)

Promote to Production: Promotes a draft version to production. (POST /agent-studio/agent/versions/{versionId}/publish)

Execute Agent (Deprecated): **Deprecated endpoint - use POST /agent/:agentId/execute instead.** Executes the specified agent and returns a non-streaming JSON response with the complete agent output. The agent must be in active status and belong to the specified... (POST /agent-studio/public-api/agents/{agentId}/execute)

Create Association: Allow you to create contact - contact , contact - custom objects associations, will add more in the future. (POST /associations)

Create Relation for you associated entities.: Create Relation. (POST /associations/relations)

Create Blog Post: The "Create Blog Post" API allows you create blog post for any given blog site. Please use blogs/post.write (POST /blogs/posts)

Create a new brand board: Creates a new brand board with logos, colors, and fonts (POST /brand-boards)

Create Business (POST /businesses)

Create Calendar: Create calendar in a location. (POST /calendars)

Create Note (POST /calendars/appointments/{appointmentId}/notes)

Create notification: Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only (POST /calendars/{calendarId}/notifications)

Create appointment (POST /calendars/events/appointments)

Create Block Slot: Create block slot (POST /calendars/events/block-slots)

Create Calendar Group (POST /calendars/groups)

Validate group slug: Validate if group slug is available or not. (POST /calendars/groups/validate-slug)

Create Calendar Resource: Create calendar resource by resource type (POST /calendars/resources/{resourceType})

Create user availability schedule: Create new schedule with specified rules, timezone, location, user and calendar associations. (POST /calendars/schedules)

Create Contact: Please find the list of acceptable values for the country field here (POST /contacts)

Add/Remove Contacts From Business: Add/Remove Contacts From Business . Passing a null businessId will remove the businessId from the contacts (POST /contacts/bulk/business)

Update Contacts Tags: Allows you to update tags to multiple contacts at once, you can add or remove tags from the contacts (POST /contacts/bulk/tags/update/{type})

Add Contact to Campaign: Add contact to Campaign (POST /contacts/{contactId}/campaigns/{campaignId})

Add Followers (POST /contacts/{contactId}/followers)

Create Note (POST /contacts/{contactId}/notes)

Add Tags (POST /contacts/{contactId}/tags)

Create Task (POST /contacts/{contactId}/tasks)

Add Contact to Workflow (POST /contacts/{contactId}/workflow/{workflowId})

Search Contacts: Search contacts based on combinations of advanced filters. (POST /contacts/search)

Upsert Contact: Please find the list of acceptable values for the country field here The Upsert API will adhere to the configuration defined under the “Allow Duplicate Contact” setting at the Location level. If the setting is configured to check both... (POST /contacts/upsert)

Create an Agent: Creates a new AI agent for the location. The agent will be created with the specified configuration including name, role, actions, and behavior settings. (POST /conversation-ai/agents)

Attach Action to Agent: Creates and attach a new action for an AI agent. Actions define specific tasks or behaviors that the agent can perform, such as booking appointments, sending follow-ups, or collecting information. (POST /conversation-ai/agents/{agentId}/actions)

Create Conversation: Creates a new conversation with the data provided (POST /conversations)

Send a new message: Post the necessary fields for the API to send a new message. (POST /conversations/messages)

Add an inbound message: Post the necessary fields for the API to add a new inbound message. (POST /conversations/messages/inbound)

Add an external outbound call: Post the necessary fields for the API to add a new outbound call. (POST /conversations/messages/outbound)

Send a review reply to Google My Business: Post a reply to a customer review on Google My Business (POST /conversations/messages/review-reply)

Complete file upload: Validates the uploaded file in GCS and returns the public URL. Call this endpoint after successfully uploading the file to the signed URL. (POST /conversations/messages/upload/complete)

Initiate file upload to GCS: Generates a signed URL for direct file upload to Google Cloud Storage. Returns a signed URL valid for 15 minutes. Upload file via PUT request, then call /complete to finalize. (POST /conversations/messages/upload/initiate)

Create Custom Subtype: Create a new custom subtype for a location. Requires agency or account admin role. (POST /conversations/preferences/custom-subtypes)

User Subscription Change: Process subscription change initiated by a user (admin/agent). Supports individual custom subscription changes and resub all functionality. Legal forms are automatically created for user-initiated resubscribe actions on custom... (POST /conversations/preferences/unsubscriptions/user-change)

Agent/Ai-Bot is typing a message indicator for live chat: Agent/AI-Bot will call this when they are typing a message in live chat message (POST /conversations/providers/live-chat/typing)

Import Courses: Import Courses through public channels (POST /courses/courses-exporter/public/import)

Create Custom Field: Create Custom Field ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (POST /custom-fields)

Create Custom Field Folder: Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (POST /custom-fields/folder)

Create Custom Menu Link: Creates a new custom menu for a company. Requires authentication and proper permissions. For Icon Usage Details please refer to https://doc.clickup.com/8631005/d/h/87cpx-243696/d60fa70db6b92b2 (POST /custom-menus)

Email Verification: Verify Email (POST /email/verify)

Create a new template (POST /emails/builder)

Update a template (POST /emails/builder/data)

Create Redirect: The "Create Redirect" API Allows adding a new url redirect to the system. Use this endpoint to create a url redirect with the specified details. Ensure that the required information is provided in the request payload. (POST /funnels/lookup/redirect)

Create Invoice: API to create an invoice (POST /invoices)

Record a manual payment for an invoice: API to record manual payment for an invoice by invoice id (POST /invoices/{invoiceId}/record-payment)

Send invoice: API to send invoice by invoice id (POST /invoices/{invoiceId}/send)

Void invoice: API to delete invoice by invoice id (POST /invoices/{invoiceId}/void)

Create New Estimate: Create a new estimate with the provided details (POST /invoices/estimate)

Create Invoice from Estimate: Create a new invoice from an existing estimate (POST /invoices/estimate/{estimateId}/invoice)

Send Estimate: API to send estimate by estimate id (POST /invoices/estimate/{estimateId}/send)

Create Estimate Template: Create a new estimate template (POST /invoices/estimate/template)

Create Invoice Schedule: API to create an invoice Schedule (POST /invoices/schedule)

Manage Auto payment for an schedule invoice: API to manage auto payment for a schedule (POST /invoices/schedule/{scheduleId}/auto-payment)

Cancel an scheduled invoice: API to cancel a scheduled invoice by schedule id (POST /invoices/schedule/{scheduleId}/cancel)

Schedule an schedule invoice: API to schedule an schedule invoice to start sending to the customer (POST /invoices/schedule/{scheduleId}/schedule)

Update scheduled recurring invoice: API to update scheduled recurring invoice (POST /invoices/schedule/{scheduleId}/updateAndSchedule)

Create template: API to create a template (POST /invoices/template)

Create & Send: API to create or update a text2pay invoice (POST /invoices/text2pay)

Create a new knowledge base (max 15 knowledge bases per location) (POST /knowledge-bases)

Start crawling and discover pages for training (POST /knowledge-bases/crawler)

Train discovered website pages and ingest into the knowledge base (POST /knowledge-bases/crawler/train)

Create a new FAQ inside knowledge base (POST /knowledge-bases/faqs)

Create Link (POST /links)

Create Sub-Account (Formerly Location): Create a new Sub-Account (Formerly Location) based on the data provided ! This feature is only available on Agency Pro ($497) plan. (POST /locations)

Create Custom Field (POST /locations/{locationId}/customFields)

Create Custom Value (POST /locations/{locationId}/customValues)

Create Recurring Task (POST /locations/{locationId}/recurring-tasks)

Create Tag: Create tag (POST /locations/{locationId}/tags)

Task Search Filter: Task Search (POST /locations/{locationId}/tasks/search)

Create a new wallet charge (POST /marketplace/billing/charges)

Migrate external authentication connection: Migrates an external authentication connection credentials (basic or oauth2) for a specific app and location. This endpoint validates the app configuration, stores credentials safely in CRM's native encrypted storage. With this the... (POST /marketplace/external-auth/migration)

Update File/ Folder: Updates a single file or folder by ID (POST /medias/{id})

Create Folder: Creates a new folder in the media storage (POST /medias/folder)

Create Custom Object: Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0 (POST /objects)

Create Record: Create a Custom Object Record. Supported Objects business and custom objects. (POST /objects/{schemaKey}/records)

Search Object Records: Supported Objects are custom objects and standard objects like "business". (POST /objects/{schemaKey}/records/search)

Create Opportunity (POST /opportunities)

Add Followers (POST /opportunities/{id}/followers)

Search Opportunities: Search Opportunities based on combinations of advanced filters. (POST /opportunities/search)

Upsert Opportunity (POST /opportunities/upsert)

Create Coupon: The "Create Coupon" API allows you to create a new promotional coupon with customizable parameters such as discount amount, validity period, usage limits, and applicable products. Use this endpoint to set up promotional offers and special... (POST /payments/coupon)

Create new provider config: API to create a new payment config for given location (POST /payments/custom-provider/connect)

Disconnect existing provider config: API to disconnect an existing payment config for given location (POST /payments/custom-provider/disconnect)

Create new integration: API to create a new association for an app and location (POST /payments/custom-provider/provider)

Create White-label Integration Provider: The "Create White-label Integration Provider" API allows adding a new payment provider integration to the system which is built on top of Authorize.net or NMI. Use this endpoint to create a integration provider with the specified details.... (POST /payments/integrations/provider/whitelabel)

Create order fulfillment: The "Order Fulfillment" API facilitates the process of fulfilling an order. (POST /payments/orders/{orderId}/fulfillments)

Record Order Payment: The "Record Order Payment" API allows to record a payment for an order. Use this endpoint to record payment for an order and update the order status to "Paid". (POST /payments/orders/{orderId}/record-payment)

Purchase a phone number: Purchase a phone number for a specific location. (POST /phone-system/numbers/location/{locationId}/purchase)

Create Product: The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload. (POST /products)

Bulk Update Products: API to bulk update products (price, availability, collections, delete) (POST /products/bulk-update)

Bulk Edit Products and Prices: API to bulk edit products and their associated prices (max 30 entities) (POST /products/bulk-update/edit)

Create Price for a Product: The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information... (POST /products/{productId}/price)

Create Product Collection: Create a new Product Collection for a specific location (POST /products/collections)

Update Inventory: The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory. (POST /products/inventory)

Update Product Reviews: Update one or multiple product reviews: status, reply, etc. (POST /products/reviews/bulk-update)

Action to include/exclude the product in store: API to update the status of products in a particular store (POST /products/store/{storeId})

Update product display priorities in store: API to set the display priority of products in a store (POST /products/store/{storeId}/priority)

Send document: Send document to a client (POST /proposals/document/send)

Send template: Send template to a client (POST /proposals/templates/send)

Disable SaaS for locations: Disable SaaS for locations for given locationIds (POST /saas-api/public-api/bulk-disable-saas/{companyId})

Bulk Enable SaaS: Enable SaaS mode for multiple locations with support for both SaaS v1 and v2 (POST /saas-api/public-api/bulk-enable-saas/{companyId})

Enable SaaS for Sub-Account (Formerly Location): Enable SaaS for Sub-Account (Formerly Location) based on the data provided ! This feature is only available on Agency Pro ($497) plan. (POST /saas-api/public-api/enable-saas/{locationId})

Pause location: Pause Sub account for given locationId (POST /saas-api/public-api/pause/{locationId})

Update Rebilling: Bulk update rebilling for given locationIds (POST /saas-api/public-api/update-rebilling/{companyId})

Disable SaaS for locations: Disable SaaS for locations for given locationIds (POST /saas/bulk-disable-saas/{companyId})

Bulk Enable SaaS: Enable SaaS mode for multiple locations with support for both SaaS v1 and v2 (POST /saas/bulk-enable-saas/{companyId})

Enable SaaS for Sub-Account (Formerly Location): Enable SaaS for Sub-Account (Formerly Location) based on the data provided ! This feature is only available on Agency Pro ($497) plan. (POST /saas/enable-saas/{locationId})

Pause location: Pause Sub account for given locationId (POST /saas/pause/{locationId})

Update Rebilling: Bulk update rebilling for given locationIds (POST /saas/update-rebilling/{companyId})

Create Snapshot Share Link: Create a share link for snapshot (POST /snapshots/share/link)

Create post: Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per... (POST /social-media-posting/{locationId}/posts)

Bulk Delete Social Planner Posts: Deletes multiple posts based on the provided list of post IDs. This operation is useful for clearing up large numbers of posts efficiently. Note: 1.The maximum number of posts that can be deleted in a single request is '50'. 2.However, It... (POST /social-media-posting/{locationId}/posts/bulk-delete)

Get posts: Get Posts (POST /social-media-posting/{locationId}/posts/list)

Set Accounts (POST /social-media-posting/{locationId}/set-accounts)

Get tags by ids (POST /social-media-posting/{locationId}/tags/details)

Attach facebook pages (POST /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId})

Set google business locations (POST /social-media-posting/oauth/{locationId}/google/locations/{accountId})

Attach Instagram Professional Accounts (POST /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId})

Attach linkedin pages and profile (POST /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId})

Attach Tiktok profile (POST /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId})

Attach Twitter profile: ! As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience. (POST /social-media-posting/oauth/{locationId}/twitter/accounts/{accountId})

Get Social Media Statistics: Retrieve analytics data for multiple social media accounts. Provides metrics for the last 7 days with comparison to the previous 7 days. Supports filtering by platforms and specific connected accounts. (POST /social-media-posting/statistics)

Create Shipping Carrier: The "Create Shipping Carrier" API allows adding a new shipping carrier. (POST /store/shipping-carrier)

Create Shipping Zone: The "Create Shipping Zone" API allows adding a new shipping zone. (POST /store/shipping-zone)

Create Shipping Rate: The "Create Shipping Rate" API allows adding a new shipping rate. (POST /store/shipping-zone/{shippingZoneId}/shipping-rate)

Get available shipping rates: This return available shipping rates for country based on order amount (POST /store/shipping-zone/shipping-rates)

Create/Update Store Settings: Create or update store settings by altId and altType. (POST /store/store-setting)

Create User (POST /users)

Filter Users by Email: Filter users by company ID, deleted status, and email array (POST /users/search/filter-by-email)

Create Agent Action: Create a new action for a voice AI agent. Actions define specific behaviors and capabilities for the agent during calls. (POST /voice-ai/actions)

Create Agent: Create a new voice AI agent configuration and settings (POST /voice-ai/agents)

Upsert ad: Create or update a Facebook ad (v2) (PUT /ad-publishing/facebook/ads-v2)

Upsert adset: Create or update a Facebook ad set (PUT /ad-publishing/facebook/adsets)

Upsert campaign: Create or update a Facebook campaign (PUT /ad-publishing/facebook/campaigns)

Update custom audience: Update name or description of a Facebook custom audience (PUT /ad-publishing/facebook/custom-audience/{audienceId})

Add custom audience member: Add a member to a Facebook custom audience (PUT /ad-publishing/facebook/custom-audience/{audienceId}/member)

Batch update audience members: Add or remove members in bulk from a Facebook custom audience via CSV or smart lists (PUT /ad-publishing/facebook/custom-audience/{audienceId}/member/batch)

Set default page: Set the default Facebook page for a location (PUT /ad-publishing/facebook/page/default)

Upsert conversion pixel: Create or update a Facebook conversion pixel configuration (PUT /ad-publishing/facebook/pixels)

Upsert Google campaign: Create or update a full Google Ads campaign structure (PUT /ad-publishing/google/ads)

Upsert audience: Create or update a Google Ads combined audience (PUT /ad-publishing/google/audiences)

Upsert conversion: Create or update a Google Ads conversion action (PUT /ad-publishing/google/conversions)

Upsert segment: Create or update a Google Ads audience segment (PUT /ad-publishing/google/segments)

Upsert ad campaign group: Create or update a LinkedIn ad campaign group with campaigns and ads (PUT /ad-publishing/linkedin/ads)

Update Association By Id: Update Association , Allows you to update labels of an associations. (PUT /associations/{associationId})

Update Blog Post: The "Update Blog Post" API allows you update blog post for any given blog site. Please use blogs/post-update.write (PUT /blogs/posts/{postId})

Update Business (PUT /businesses/{businessId})

Update Note (PUT /calendars/appointments/{appointmentId}/notes/{noteId})

Update Calendar: Update calendar by ID. (PUT /calendars/{calendarId})

Update notification: Update Event notification by id (PUT /calendars/{calendarId}/notifications/{notificationId})

Update Appointment: Update appointment (PUT /calendars/events/appointments/{eventId})

Update Block Slot: Update block slot by ID (PUT /calendars/events/block-slots/{eventId})

Update Group: Update Group by group ID (PUT /calendars/groups/{groupId})

Disable Group (PUT /calendars/groups/{groupId}/status)

Update Calendar Resource: Update calendar resource by ID (PUT /calendars/resources/{resourceType}/{id})

Update user availability schedule: Modify an existing schedule by updating its rules, timezone, and name All fields are optional - only provided fields will be updated. (PUT /calendars/schedules/{id})

Apply user availability schedule to a calendar: Associates a calendar with the given schedule by adding the calendarId to a schedule (PUT /calendars/schedules/{id}/associations/{calendarId})

Update Contact: Please find the list of acceptable values for the country field here (PUT /contacts/{contactId})

Update Note (PUT /contacts/{contactId}/notes/{id})

Update Task (PUT /contacts/{contactId}/tasks/{taskId})

Update Task Completed (PUT /contacts/{contactId}/tasks/{taskId}/completed)

Update Agent: Updates an existing AI agent's configuration. All fields in the agent configuration can be updated including name, status, actions, and behavior settings. (PUT /conversation-ai/agents/{agentId})

Update Action: Updates an existing action's configuration. This includes modifying the action name, description, trigger conditions, and behavior settings. (PUT /conversation-ai/agents/{agentId}/actions/{actionId})

Update Conversation: Update the conversation details based on the conversation ID (PUT /conversations/{conversationId})

Add message attachments: Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for TYPE_CUSTOM_CALL (34) and TYPE_CALL (1) with subType EXTERNAL_CALL. (PUT /conversations/messages/{messageId}/attachments)

Update message status: Post the necessary fields for the API to update message status. (PUT /conversations/messages/{messageId}/status)

Update Custom Subtype: Update or archive a custom subtype. Requires agency or account admin role. (PUT /conversations/preferences/custom-subtypes/{id})

Update Custom Field By Id: Update Custom Field By Id ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (PUT /custom-fields/{id})

Update Custom Field Folder Name: Create Custom Field Folder ! Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. (PUT /custom-fields/folder/{id})

Update Custom Menu Link: Updates an existing custom menu for a given company. Requires authentication and proper permissions. (PUT /custom-menus/{customMenuId})

Update invoice: API to update invoice by invoice id (PUT /invoices/{invoiceId})

Update Estimate: Update an existing estimate with new details (PUT /invoices/estimate/{estimateId})

Update Estimate Template: Update an existing estimate template (PUT /invoices/estimate/template/{templateId})

Update schedule: API to update an schedule by schedule id (PUT /invoices/schedule/{scheduleId})

Update template: API to update an template by template id (PUT /invoices/template/{templateId})

Update a knowledge base (PUT /knowledge-bases/{id})

Update an existing knowledge base FAQ (PUT /knowledge-bases/faqs/{id})

Update Link (PUT /links/{linkId})

Put Sub-Account (Formerly Location): Update a Sub-Account (Formerly Location) based on the data provided (PUT /locations/{locationId})

Update Custom Field (PUT /locations/{locationId}/customFields/{id})

Update Custom Value (PUT /locations/{locationId}/customValues/{id})

Update Recurring Task (PUT /locations/{locationId}/recurring-tasks/{id})

Update tag (PUT /locations/{locationId}/tags/{tagId})

Bulk Delete / Trash Files or Folders: Soft-deletes or trashes multiple files and folders in a single request (PUT /medias/delete-files)

Bulk Update Files/ Folders: Updates metadata or status of multiple files and folders (PUT /medias/update-files)

Update Object Schema By Key / Id: Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here :... (PUT /objects/{key})

Update Record: Update a Custom Object Record by Id. Supported Objects are business and custom objects. (PUT /objects/{schemaKey}/records/{id})

Update Opportunity (PUT /opportunities/{id})

Update Opportunity Status (PUT /opportunities/{id}/status)

Update Coupon: The "Update Coupon" API enables you to modify existing coupon details such as discount values, validity periods, usage limits, and other promotional parameters. Use this endpoint to adjust or extend promotional offers for your customers. (PUT /payments/coupon)

Custom-provider marketplace app update capabilities: Toggle capabilities for the marketplace app tied to the OAuth client (PUT /payments/custom-provider/capabilities)

Update Product by ID: The "Update Product by ID" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product ID. (PUT /products/{productId})

Update Price by ID for a Product: The "Update Price by ID for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a single price based on the provided... (PUT /products/{productId}/price/{priceId})

Update Product Collection: Update a specific product collection with Id :collectionId (PUT /products/collections/{collectionId})

Update Product Reviews: Update status, reply, etc of a particular review (PUT /products/reviews/{reviewId})

Update SaaS subscription: Update SaaS subscription for given locationId and customerId (PUT /saas-api/public-api/update-saas-subscription/{locationId})

Update SaaS subscription: Update SaaS subscription for given locationId and customerId (PUT /saas/update-saas-subscription/{locationId})

Edit post: Create posts for all supported platforms. It is possible to create customized posts per channel by using the same platform account IDs in a request and hitting the create post API multiple times with different summaries and account IDs per... (PUT /social-media-posting/{locationId}/posts/{id})

Update Shipping Carrier: The "update Shipping Carrier" API allows update a shipping carrier to the system. (PUT /store/shipping-carrier/{shippingCarrierId})

Update Shipping Zone: The "update Shipping Zone" API allows update a shipping zone to the system. (PUT /store/shipping-zone/{shippingZoneId})

Update Shipping Rate: The "update Shipping Rate" API allows update a shipping rate to the system. (PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId})

Update User (PUT /users/{userId})

Update Agent Action: Update an existing action for a voice AI agent. Modifies the behavior and configuration of an agent action. (PUT /voice-ai/actions/{actionId})