Skip to content
Changelog

Report a bug

Highlevel integration: operations for AI agents

Highlevel connects to Type.com as an integration. This page lists the 663 operations documented for Claude and Codex in Type.com: 283 read, 198 write, 182 destructive.

About Highlevel

HighLevel provides a marketing automation and CRM platform for agencies, featuring funnels, appointment scheduling, two-way texting, and other tools to drive client success

Categories: Marketing & Social

How to connect Highlevel to Type.com

Connect
Managed OAuth through Pipedream when enabled for your workspace
Access
Organization connection: one shared account for the workspace.
MCP
Selected payment-processing and social-publishing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

663 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

663 operations listed.

Workflows

  • Read

    Get Workflow

    Get Workflow

    GET /workflows/

Agents

  • Read

    List Agents

    Retrieve a paginated list of agents for given location.

    GET /voice-ai/agents

  • Read

    Get Agent

    Retrieve detailed configuration and settings for a specific voice AI agent

    GET /voice-ai/agents/{agentId}

  • Read

    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

  • Read

    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}

  • Read

    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 production version.

    GET /agent-studio/agent

  • Read

    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 status.

    GET /agent-studio/agent/{agentId}

  • Read

    List Agents (Deprecated) (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

  • Read

    Get Agent (Deprecated) (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}

  • Write

    Create Agent

    Create a new voice AI agent configuration and settings

    POST /voice-ai/agents

  • Write

    Patch Agent

    Partially update an existing voice AI agent

    PATCH /voice-ai/agents/{agentId}

  • Write

    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

  • Write

    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

  • Write

    Update Agent

    Updates a specific agent version by versionId. Supports updating nodes, edges, variables, and configuration.

    PATCH /agent-studio/agent/versions/{versionId}

  • Write

    Update Agent Metadata

    Updates agent metadata such as name, description, and status.

    PATCH /agent-studio/agent/{agentId}

  • Write

    Promote to Production

    Promotes a draft version to production.

    POST /agent-studio/agent/versions/{versionId}/publish

  • Write

    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 Management: - For the first message in a new session, do not include the executionId in the request payload. - The API will return an executionId along with the agent response, which uniquely identifies this conversation session. - To continue the conversation within the same session, include the executionId from the previous response in subsequent requests. This allows the agent to maintain conversation context and history across multiple interactions.

    POST /agent-studio/agent/{agentId}/execute

  • Write

    Execute Agent (Deprecated) (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 location. locationId is required in the request body. Session Management: - For the first message in a new session, do not include the executionId in the request payload. - The API will return an executionId along with the agent response, which uniquely identifies this conversation session. - To continue the conversation within the same session, include the executionId from the previous response in subsequent requests.

    POST /agent-studio/public-api/agents/{agentId}/execute

  • Destructive

    Delete Agent

    Delete a voice AI agent and all its configurations

    DELETE /voice-ai/agents/{agentId}

  • Destructive

    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}

  • Destructive

    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}

  • Destructive

    Delete Agent

    Deletes an agent and all its versions.

    DELETE /agent-studio/agent/{agentId}

Dashboard

  • Read

    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

  • Read

    Get Call Log

    Returns a call log by callId.

    GET /voice-ai/dashboard/call-logs/{callId}

Actions

  • Read

    Get Agent Action

    Retrieve details of a specific action by its ID. Returns the action configuration including actionParameters.

    GET /voice-ai/actions/{actionId}

  • Read

    List Actions for an Agent

    List for actions for an agent

    GET /conversation-ai/agents/{agentId}/actions/list

  • Read

    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}

  • Write

    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

  • Write

    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

  • Write

    Update Followup Settings

    Update the followup settings for an action

    PATCH /conversation-ai/agents/{agentId}/followup-settings

  • Destructive

    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}

  • Destructive

    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}

  • Destructive

    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}

  • Destructive

    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}

Search

  • Read

    Search Users

    Search Users

    GET /users/search

  • Read

    Search Opportunity

    Search Opportunity

    GET /opportunities/search

  • Read

    Search Opportunities

    Search Opportunities based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-424216/7bf11bc9b94f80f

    POST /opportunities/search

  • Read

    Search

    Search Sub-Account (Formerly Location)

    GET /locations/search

  • Read

    Search Conversations

    Returns a list of all conversations matching the search criteria along with the sort and filter options selected.

    GET /conversations/search

  • Read

    Search Contacts

    Search contacts based on combinations of advanced filters. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-158396/6e629989abe7fad

    POST /contacts/search

  • Read

    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 be phone.

    GET /contacts/search/duplicate

  • Write

    Filter Users by Email

    Filter users by company ID, deleted status, and email array

    POST /users/search/filter-by-email

Users

  • Read

    Get User

    Get User

    GET /users/{userId}

  • Read

    Get User by Location (deprecated)

    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/

  • Write

    Create User

    Create User

    POST /users/

  • Destructive

    Update User

    Update User

    PUT /users/{userId}

  • Destructive

    Delete User

    Delete User

    DELETE /users/{userId}

Surveys

  • Read

    Get Surveys Submissions

    Get Surveys Submissions

    GET /surveys/submissions

  • Read

    Get Surveys

    Get Surveys

    GET /surveys/

Shipping Zone

  • Read

    List Shipping Zones

    The "List Shipping Zone" API allows to retrieve a list of shipping zone.

    GET /store/shipping-zone

  • Read

    Get Shipping Zone

    The "List Shipping Zone" API allows to retrieve a paginated list of shipping zone.

    GET /store/shipping-zone/{shippingZoneId}

  • Read

    Get available shipping rates

    This return available shipping rates for country based on order amount

    POST /store/shipping-zone/shipping-rates

  • Write

    Create Shipping Zone

    The "Create Shipping Zone" API allows adding a new shipping zone.

    POST /store/shipping-zone

  • Destructive

    Update Shipping Zone

    The "update Shipping Zone" API allows update a shipping zone to the system.

    PUT /store/shipping-zone/{shippingZoneId}

  • Destructive

    Delete shipping zone

    Delete specific shipping zone with Id :shippingZoneId

    DELETE /store/shipping-zone/{shippingZoneId}

Shipping Zone Rates

  • Read

    List Shipping Rates

    The "List Shipping Rate" API allows to retrieve a list of shipping rate.

    GET /store/shipping-zone/{shippingZoneId}/shipping-rate

  • Read

    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}

  • Write

    Create Shipping Rate

    The "Create Shipping Rate" API allows adding a new shipping rate.

    POST /store/shipping-zone/{shippingZoneId}/shipping-rate

  • Destructive

    Update Shipping Rate

    The "update Shipping Rate" API allows update a shipping rate to the system.

    PUT /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}

  • Destructive

    Delete shipping rate

    Delete specific shipping rate with Id :shippingRateId

    DELETE /store/shipping-zone/{shippingZoneId}/shipping-rate/{shippingRateId}

Shipping Carrier

  • Read

    List Shipping Carriers

    The "List Shipping Carrier" API allows to retrieve a list of shipping carrier.

    GET /store/shipping-carrier

  • Read

    Get Shipping Carrier

    The "List Shipping Carrier" API allows to retrieve a paginated list of shipping carrier.

    GET /store/shipping-carrier/{shippingCarrierId}

  • Write

    Create Shipping Carrier

    The "Create Shipping Carrier" API allows adding a new shipping carrier.

    POST /store/shipping-carrier

  • Destructive

    Update Shipping Carrier

    The "update Shipping Carrier" API allows update a shipping carrier to the system.

    PUT /store/shipping-carrier/{shippingCarrierId}

  • Destructive

    Delete shipping carrier

    Delete specific shipping carrier with Id :shippingCarrierId

    DELETE /store/shipping-carrier/{shippingCarrierId}

Store Setting

  • Read

    Get Store Settings

    Get store settings by altId and altType.

    GET /store/store-setting

  • Write

    Create/Update Store Settings

    Create or update store settings by altId and altType.

    POST /store/store-setting

Post

  • Read

    Get posts

    Get Posts

    POST /social-media-posting/{locationId}/posts/list

  • Read

    Get post

    Get post

    GET /social-media-posting/{locationId}/posts/{id}

  • Write

    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 platform. The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link: Link: Platform Limitations

    POST /social-media-posting/{locationId}/posts

  • Destructive

    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 platform. The content and media limitations, as well as platform rate limiters corresponding to the respective platforms, are provided in the following reference link: Link: Platform Limitations

    PUT /social-media-posting/{locationId}/posts/{id}

  • Destructive

    Delete Post

    Delete Post

    DELETE /social-media-posting/{locationId}/posts/{id}

  • Destructive

    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 will only get deleted in CRM database but still it is recommended to be cautious of this operation.

    POST /social-media-posting/{locationId}/posts/bulk-delete

Account

  • Read

    Get Accounts

    Get list of accounts and groups

    GET /social-media-posting/{locationId}/accounts

  • Destructive

    Delete Account

    Delete account and account from group

    DELETE /social-media-posting/{locationId}/accounts/{id}

CSV

  • Read

    Get Upload Status

    Get the status of all CSV imports for a location

    GET /social-media-posting/{locationId}/csv

  • Read

    Get CSV Post

    Get details of a specific CSV import including its posts

    GET /social-media-posting/{locationId}/csv/{id}

  • Write

    Upload CSV

    Upload a CSV file containing social media posts for bulk scheduling

    POST /social-media-posting/{locationId}/csv

  • Write

    Set Accounts

    Set social media accounts for a CSV import to publish posts to

    POST /social-media-posting/{locationId}/set-accounts

  • Write

    Start CSV Finalize

    Finalize a CSV import and schedule all posts for publishing

    PATCH /social-media-posting/{locationId}/csv/{id}

  • Destructive

    Delete CSV

    Delete a CSV import and all its associated posts

    DELETE /social-media-posting/{locationId}/csv/{id}

  • Destructive

    Delete CSV Post

    Delete a specific post from a CSV import

    DELETE /social-media-posting/{locationId}/csv/{csvId}/post/{postId}

OAuth | Generic

  • Read

    Get Available Accounts (Step 2 of 3)

    OAuth Connection Flow - Step 2: Get Available Accounts After completing OAuth authentication (Step 1), use this endpoint to retrieve the list of available pages, channels, or locations that can be connected. OAuth Flow Position 1. Start OAuth → User authenticates, returns accountId 2. Get Accounts (this endpoint) → Lists available pages/channels to connect 3. Attach Account → Connect the selected account What This Returns The response varies by platform: | Platform | Returns | |----------|--------| | facebook | List of Facebook Pages the user manages | | instagram | List of Instagram Professional Accounts (linked to Facebook Pages) | | google | Google Business Profile locations | | linkedin | LinkedIn Pages and Profile | | tiktok | TikTok Creator account info | | tiktok-business | TikTok Business Center accounts | | youtube | YouTube Channels | | pinterest | Pinterest Business accounts and boards | | threads | Threads profiles | Next Step From the response, select the account/page you want to connect and use its details in Step 3: POST /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId}

    GET /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId}

  • Write

    Start OAuth Flow (Step 1 of 3)

    OAuth Connection Flow - Step 1: Initiate OAuth This is the first step in the 3-step OAuth flow to connect a social media account: 1. Start OAuth (this endpoint) → User authenticates with the platform 2. Get Accounts → Retrieve available pages/channels to connect 3. Attach Account → Connect the selected account to your location How to Use Open this API in a browser window (not via cURL) with the required query parameters. The user will be redirected to the platform's OAuth login screen. Receiving the OAuth Response After successful authentication, the OAuth window will post a message back to your application. Listen for this message to get the accountId needed for the next step. javascript window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data; // Use accountId for Step 2: GET /oauth/{locationId}/{platform}/accounts/{accountId} } }, false); Event Data Response | Field | Type | Example | Description | |-------|------|---------|-------------| | actionType | string | "close" | The action type | | page | string | "social-media-posting" | Source page identifier | | platform | string | "facebook" | The OAuth platform | | placement | string | "placement" | Placement context | | accountId | string | "658a9b6833b91e0ecb8f3958" | Use this for Step 2 | | reconnectAccounts | string[] | ["658a9b...", "efd2da..."] | Accounts that need reconnection | Next Step Use the accountId from the response to call: GET /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId} Platform Notes - bluesky: Currently not supported, will return an error - tiktok-business: Uses a separate business OAuth flow

    GET /social-media-posting/oauth/{platform}/start

  • Write

    Connect Account (Step 3 of 3)

    OAuth Connection Flow - Step 3: Connect the Account This is the final step in the OAuth flow. After retrieving available accounts (Step 2), use this endpoint to connect the selected account to your location. OAuth Flow Summary 1. Start OAuth → User authenticates with platform 2. Get Accounts → Retrieved available pages/channels 3. Attach Account (this endpoint) → Connect the selected account Request Body by Platform The request body structure varies depending on the platform: Facebook / Instagram json { "type": "page", "originId": "244405XXXXX11687", "name": "My Facebook Page", "avatar": "https://..." // optional } Google Business Profile json { "location": { "name": "locations/12345", "title": "My Business Location", "storeCode": "STORE123", "isVerified": "ChIJsZQpj1qbXjkRQNDUG4UUx6k" }, "account": { "name": "accounts/12345", "accountName": "My Business Account", "type": "LOCATIONGROUP", "verificationState": "VERIFIED", "vettedState": "VETTED" } } LinkedIn json { "type": "page", "originId": "urn:li:organization:12345", "name": "My LinkedIn Page", "avatar": "https://..." // optional } TikTok json { "originId": "7234567890123456789", "name": "My TikTok Account", "avatar": "https://..." // optional } YouTube json { "originId": "UCxxxxxxxxxxxxxxxx", "name": "My YouTube Channel", "avatar": "https://..." // optional } Pinterest json { "originId": "123456789", "name": "My Pinterest Account", "avatar": "https://..." // optional } After Connection Once connected, the account will appear in your location's connected accounts and can be used for social media posting.

    POST /social-media-posting/oauth/{locationId}/{platform}/accounts/{accountId}

Category

  • Read

    Get categories by location id

    Retrieve all categories for a specific location with optional search and pagination

    GET /social-media-posting/{locationId}/categories

  • Read

    Get categories by id

    Retrieve a specific category by its ID

    GET /social-media-posting/{locationId}/categories/{id}

Tag

  • Read

    Get tags by location id

    Retrieve all tags for a specific location with optional search and pagination

    GET /social-media-posting/{locationId}/tags

  • Read

    Get tags by ids

    Retrieve specific tags by their IDs

    POST /social-media-posting/{locationId}/tags/details

Statistics

  • Read

    Get Social Media Statistics

    Retrieve analytics data for multiple social media accounts. Supports custom date ranges for both the current period and a comparison period. If no date ranges are provided, defaults to the last 7 days (excluding today) with comparison to the previous 7 days.

    POST /social-media-posting/statistics

  • Read

    Get Campaign Statistics

    Get statistics for email campaigns, workflows, or bulk actions

    GET /emails/locations/{locationId}/campaigns/stats/{source}/{sourceId}

Category Queue

  • Read

    Get all categories with their queue status

    Returns categories with status: "available" (no queue), "inqueue" (active/paused queue), or "draft" (queue in draft).

    GET /social-media-posting/category/queues/available-categories

  • Read

    Fetch category queues for a location

    Retrieves a paginated list of all category queues for a given location, excluding any that have been marked as deleted.

    POST /social-media-posting/category/queues/list

  • Read

    Fetch a category queue by ID

    Retrieves the details of a single category queue by its unique ID. The response includes a count of posts within the queue that have errors.

    GET /social-media-posting/category/queues/{queueId}

  • Read

    Fetch items from a queue

    Returns paginated queue items. Pass sessionId to get draft items from an edit session instead of live items.

    POST /social-media-posting/category/queues/{queueId}/items

  • Read

    Fetch calendar view for an edit session

    Retrieves a calendar preview of scheduled posts based on draft items within an edit session. This shows how posts would be scheduled if changes were saved.

    POST /social-media-posting/category/queues/{queueId}/edit/calendar

  • Read

    Fetch slot information for queue items

    Returns paginated slot information (scheduledDateTime, isSkipped) for queue items. Pass sessionId to get slots for draft items, or omit for live items. Call this after mutations to refresh slot data.

    POST /social-media-posting/category/queues/{queueId}/slots

  • Read

    Get scheduled posts calendar view

    Returns scheduled posts from active queues within a date range. Supports filtering by categories and accounts.

    POST /social-media-posting/category/queues/list/calendar

  • Write

    Create a new category queue

    Creates a queue in draft status for a category. Published posts are auto-added. Use update endpoint to activate.

    POST /social-media-posting/category/queues

  • Write

    Start or resume an edit session

    Creates a draft copy of queue items for editing. Changes are staged until saved or discarded.

    POST /social-media-posting/category/queues/{queueId}/edit/start

  • Write

    Clone a queue item

    Duplicates an existing queue item at a specified order position. Requires an active edit session.

    POST /social-media-posting/category/queues/{queueId}/items/{itemId}/clone

  • Write

    Create a new item in the queue

    Adds a new post item to a queue. Use sessionId for edit session or directToQueue for immediate addition.

    POST /social-media-posting/category/queues/{queueId}/create/item

  • Destructive

    Update queue settings or status

    Updates queue status (active/paused/deleted), time slots, or skip dates.

    PUT /social-media-posting/category/queues/{queueId}

  • Destructive

    Save edit session changes

    Applies all staged changes to the live queue and closes the edit session.

    POST /social-media-posting/category/queues/{queueId}/edit/save

  • Destructive

    Discard edit session changes

    Cancels the edit session and deletes all staged changes without affecting the live queue.

    POST /social-media-posting/category/queues/{queueId}/edit/discard

  • Destructive

    Update an item in a queue

    Updates the content or variations of a specific item within a category queue.

    PUT /social-media-posting/category/queues/{queueId}/items/{itemId}

  • Destructive

    Delete an item from a queue

    Deletes an item from a specific category queue.

    DELETE /social-media-posting/category/queues/{queueId}/items/{itemId}

  • Destructive

    Delete an active post and schedule the next one

    Deletes a post that is currently scheduled and automatically triggers the scheduling of the next available post in the queue.

    DELETE /social-media-posting/category/queues/{postId}/active-post

  • Destructive

    Reset an item in a queue

    Resets a specific queue item to its original state, discarding any modifications made.

    PUT /social-media-posting/category/queues/{queueId}/items/{itemId}/reset

Comments

  • Read

    List comments for a post or thread

    Paginated list of comments scoped to a post (parentId = postId) or a comment thread (parentId = commentId). Use skip/limit for pagination, sortBy for ordering, originIds to filter by connected account, and search for keyword search.

    POST /social-media-posting/comments/{platform}/list

  • Write

    Create a comment or reply

    Create a top-level comment on a post (isParentThread: true, parentId = postId) or a reply to an existing comment (isParentThread: false, parentId = commentId). Per-platform content max length: Facebook 8000, Instagram 2200, Linkedin 3000, Community 8000, Tiktok 150, Bluesky 300, Youtube 10000, Threads 500. Optional-field platform support: - attachments — supported on Facebook only. Ignored on Instagram, LinkedIn, TikTok, Bluesky, Community (Community processes the field but external URLs are not rendered due to its bucket restriction). - mentions — supported on Facebook, LinkedIn, and Community only. Ignored on Instagram, TikTok, Bluesky. - notifyAllGroupMembers — supported on Community only. When true, all group members get a push/in-app notification (equivalent to an @everyone broadcast). Independent of the mentions array and of @everyone text in content. Default false.

    POST /social-media-posting/comments/{platform}

  • Write

    Like a comment

    Like a comment by its Highlevel comment ID (the id returned by the list-comments endpoint — not the native platform ID). Works for any comment level — top-level comments, replies, and replies-to-replies. Supported platforms: Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing instagram returns 400).

    POST /social-media-posting/comments/{platform}/{id}/like

  • Destructive

    Unlike a comment

    Remove a like from a comment by its Highlevel comment ID (the id returned by the list-comments endpoint — not the native platform ID). Works for any comment level — top-level comments, replies, and replies-to-replies. Supported platforms: Facebook, LinkedIn, Community, TikTok, Bluesky. Instagram is not supported (passing instagram returns 400).

    DELETE /social-media-posting/comments/{platform}/{id}/like

Snapshots

  • Read

    Get Snapshots

    Get a list of all own and imported Snapshots

    GET /snapshots/

  • Read

    Get Snapshot Push between Dates

    Get list of sub-accounts snapshot pushed in time period

    GET /snapshots/snapshot-status/{snapshotId}

  • Read

    Get Last Snapshot Push

    Get Latest Snapshot Push Status for a location id

    GET /snapshots/snapshot-status/{snapshotId}/location/{locationId}

Saas

  • Read

    Get locations by stripeId with companyId (deprecated)

    Get locations by stripeCustomerId or stripeSubscriptionId with companyId

    GET /saas-api/public-api/locations

  • Read

    Get Agency Plans (deprecated)

    Fetch all agency subscription plans for a given company ID

    GET /saas-api/public-api/agency-plans/{companyId}

  • Read

    Get Location Subscription Details (deprecated)

    Fetch subscription details for a specific location from location metadata

    GET /saas-api/public-api/get-saas-subscription/{locationId}

  • Read

    Get SaaS Locations (deprecated)

    Fetch all SaaS-activated locations for a company with pagination

    GET /saas-api/public-api/saas-locations/{companyId}

  • Read

    Get SaaS Plan (deprecated)

    Fetch a specific SaaS plan by plan ID

    GET /saas-api/public-api/saas-plan/{planId}

  • Read

    Get locations by stripeId with companyId

    Get locations by stripeCustomerId or stripeSubscriptionId with companyId

    GET /saas/locations

  • Read

    Get Agency Plans

    Fetch all agency subscription plans for a given company ID

    GET /saas/agency-plans/{companyId}

  • Read

    Get Location Subscription Details

    Fetch subscription details for a specific location from location metadata

    GET /saas/get-saas-subscription/{locationId}

  • Read

    Get SaaS Locations

    Fetch all SaaS-activated locations for a company with pagination

    GET /saas/saas-locations/{companyId}

  • Read

    Get SaaS Plan

    Fetch a specific SaaS plan by plan ID

    GET /saas/saas-plan/{planId}

  • Read

    Get Location Wallet Balance

    Fetch the wallet balance for a specific location. Returns a resource object with balance details.

    GET /saas-api/public-api/companies/{companyId}/locations/{locationId}/wallet-balance

  • Write

    Disable SaaS for locations (deprecated)

    Disable SaaS for locations for given locationIds

    POST /saas-api/public-api/bulk-disable-saas/{companyId}

  • Write

    Enable SaaS for Sub-Account (Formerly Location) (deprecated)

    Enable SaaS for Sub-Account (Formerly Location) based on the data provided :::info This feature is only available on Agency Pro ($497) plan. :::

    POST /saas-api/public-api/enable-saas/{locationId}

  • Write

    Pause location (deprecated)

    Pause Sub account for given locationId

    POST /saas-api/public-api/pause/{locationId}

  • Write

    Update Rebilling (deprecated)

    Bulk update rebilling for given locationIds

    POST /saas-api/public-api/update-rebilling/{companyId}

  • Write

    Bulk Enable SaaS (deprecated)

    Enable SaaS mode for multiple locations with support for both SaaS v1 and v2

    POST /saas-api/public-api/bulk-enable-saas/{companyId}

  • Write

    Disable SaaS for locations

    Disable SaaS for locations for given locationIds

    POST /saas/bulk-disable-saas/{companyId}

  • Write

    Enable SaaS for Sub-Account (Formerly Location)

    Enable SaaS for Sub-Account (Formerly Location) based on the data provided :::info This feature is only available on Agency Pro ($497) plan. :::

    POST /saas/enable-saas/{locationId}

  • Write

    Pause location

    Pause Sub account for given locationId

    POST /saas/pause/{locationId}

  • Write

    Update Rebilling

    Bulk update rebilling for given locationIds

    POST /saas/update-rebilling/{companyId}

  • Write

    Bulk Enable SaaS

    Enable SaaS mode for multiple locations with support for both SaaS v1 and v2

    POST /saas/bulk-enable-saas/{companyId}

  • Write

    Allow Attach Rebilling

    Marks a SaaS sub-account as awaiting rebilling attach and optionally stores the rebilling configuration that should be applied when the rebilling config is created. Sets paymentpending on the sub-account. Only allowed when the sub-account is in setuppending state.

    POST /saas/allow-attach-rebilling/{locationId}

  • Write

    Update Location Wallet Balance

    Update the wallet balance or complimentary credit settings for a specific location. Supports partial updates via updateMask field (AIP-134 compliant).

    POST /saas-api/public-api/companies/{companyId}/locations/{locationId}/wallet-balance/complimentary-credits

Documents

  • Read

    List documents

    List documents for a location

    GET /proposals/document

  • Write

    Send document

    Send document to a client

    POST /proposals/document/send

Templates

  • Read

    List templates

    List document contract templates for a location

    GET /proposals/templates

  • Read

    List templates

    Get list of templates by location

    GET /emails/locations/{locationId}/templates

  • Read

    Get Email Template by ID

    Get a single email template by its ID

    GET /emails/locations/{locationId}/templates/{templateId}

  • Read

    Fetch email templates

    Fetch email templates by location id

    GET /emails/builder

  • Write

    Send template

    Send template to a client

    POST /proposals/templates/send

  • Write

    Create an email template

    Create a new email template

    POST /emails/locations/{locationId}/templates

  • Write

    Import an email template

    Import a template from a provider URL

    POST /emails/locations/{locationId}/templates/import

  • Write

    Create a template folder

    Create a new template folder

    POST /emails/locations/{locationId}/templates/folders

  • Write

    Update an email template

    Update email template

    PATCH /emails/locations/{locationId}/templates/{templateId}

  • Write

    Create a new template

    Create a new template

    POST /emails/builder

  • Write

    Update a template

    Update a template

    POST /emails/builder/data

  • Destructive

    Delete a template

    Delete a template

    DELETE /emails/locations/{locationId}/templates/{templateId}

  • Destructive

    Delete a template

    Delete a template

    DELETE /emails/builder/{locationId}/{templateId}

Products

  • Read

    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}

  • Read

    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 way to explore and retrieve product information.

    GET /products/

  • Write

    Bulk Edit Products and Prices

    API to bulk edit products and their associated prices (max 30 entities)

    POST /products/bulk-update/edit

  • Write

    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/

  • Destructive

    Bulk Update Products

    API to bulk update products (price, availability, collections, delete)

    POST /products/bulk-update

  • Destructive

    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}

  • Destructive

    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}

Prices

  • Read

    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

  • Read

    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

  • Read

    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 ID and product ID.

    GET /products/{productId}/price/{priceId}

  • Write

    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 is provided in the request payload.

    POST /products/{productId}/price

  • Write

    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

  • Destructive

    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 price ID and product ID.

    PUT /products/{productId}/price/{priceId}

  • Destructive

    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}

Store

  • Read

    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

  • Write

    Action to include/exclude the product in store

    API to update the status of products in a particular store

    POST /products/store/{storeId}

  • Write

    Update product display priorities in store

    API to set the display priority of products in a store

    POST /products/store/{storeId}/priority

Collections

  • Read

    Fetch Product Collections

    Internal API to fetch the Product Collections

    GET /products/collections

  • Read

    Get Details about individual product collection

    Get Details about individual product collection

    GET /products/collections/{collectionId}

  • Write

    Create Product Collection

    Create a new Product Collection for a specific location

    POST /products/collections

  • Destructive

    Update Product Collection

    Update a specific product collection with Id :collectionId

    PUT /products/collections/{collectionId}

  • Destructive

    Delete Product Collection

    Delete specific product collection with Id :collectionId

    DELETE /products/collections/{collectionId}

Reviews

  • Read

    Fetch Product Reviews

    API to fetch the Product Reviews

    GET /products/reviews

  • Read

    Fetch Review Count as per status

    API to fetch the Review Count as per status

    GET /products/reviews/count

  • Write

    Update Product Reviews

    Update one or multiple product reviews: status, reply, etc.

    POST /products/reviews/bulk-update

  • Destructive

    Update Product Reviews

    Update status, reply, etc of a particular review

    PUT /products/reviews/{reviewId}

  • Destructive

    Delete Product Review

    Delete specific product review

    DELETE /products/reviews/{reviewId}

Lc phone

  • Read

    List number pools

    Returns number pools for the location. Requires locationId as a query parameter.

    GET /phone-system/number-pools

  • Read

    List available phone numbers

    Search Twilio inventory for purchasable phone numbers in a country for the given location.

    GET /phone-system/numbers/location/{locationId}/available

  • Read

    List active numbers

    List active numbers. With version: v3, the HTTP 200 body is the standard success envelope (status, data, message, statusCode). The v3 list payload is under data; isUnderGhl is renamed to isUnderLc per AIP naming convention.

    GET /phone-system/numbers/location/{locationId}

  • Write

    Purchase number for location

    Purchase number for location. With version: v3, the HTTP 201 body is the standard success envelope (status, data, message, statusCode). The v3 purchase fields live under data: number, locationId, id, and underLcAccount (renamed from underghlaccount).

    POST /phone-system/numbers/location/{locationId}/purchase

Integrations

  • Read

    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) based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve integration provider information.

    GET /payments/integrations/provider/whitelabel

  • Write

    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. Ensure that the required information is provided in the request payload. This endpoint can be only invoked using marketplace-app token

    POST /payments/integrations/provider/whitelabel

Orders

  • Read

    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 the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve order information.

    GET /payments/orders

  • Read

    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}

  • Write

    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

Order fulfillments

  • Read

    List fulfillment

    List all fulfillment history of an order

    GET /payments/orders/{orderId}/fulfillments

  • Write

    Create order fulfillment

    The "Order Fulfillment" API facilitates the process of fulfilling an order.

    POST /payments/orders/{orderId}/fulfillments

Order Notes

  • Read

    List Order Notes

    List all notes of an order

    GET /payments/orders/{orderId}/notes

Transactions

  • Read

    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 id, entity id or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve transaction information.

    GET /payments/transactions

  • Read

    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}

Subscriptions

  • Read

    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, subscription id, entity id, contact or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve subscription information.

    GET /payments/subscriptions

  • Read

    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}

Coupons

  • Read

    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

  • Read

    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, and other promotional details.

    GET /payments/coupon

  • Write

    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 discounts for your customers.

    POST /payments/coupon

  • Destructive

    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

  • Destructive

    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

Custom Provider

  • Read

    Fetch given provider config

    API for fetching an existing payment config for given location

    GET /payments/custom-provider/connect

  • Write

    Create new integration

    API to create a new association for an app and location

    POST /payments/custom-provider/provider

  • Write

    Create new provider config

    API to create a new payment config for given location

    POST /payments/custom-provider/connect

  • Write

    Disconnect existing provider config

    API to disconnect an existing payment config for given location

    POST /payments/custom-provider/disconnect

  • Destructive

    Deleting an existing integration

    API to delete an association for an app and location

    DELETE /payments/custom-provider/provider

  • Destructive

    Custom-provider marketplace app update capabilities

    Toggle capabilities for the marketplace app tied to the OAuth client

    PUT /payments/custom-provider/capabilities

Lost reason

  • Read

    Get lost reason

    Get lost reason

    GET /opportunities/lost-reason

Pipelines

  • Read

    Get Pipelines

    Get Pipelines

    GET /opportunities/pipelines

Opportunities

  • Read

    Get Opportunity

    Get Opportunity

    GET /opportunities/{id}

  • Write

    Upsert Opportunity

    Upsert Opportunity

    POST /opportunities/upsert

  • Write

    Create Opportunity

    Create Opportunity

    POST /opportunities/

  • Destructive

    Update Opportunity

    Update Opportunity

    PUT /opportunities/{id}

  • Destructive

    Delete Opportunity

    Delete Opportunity

    DELETE /opportunities/{id}

  • Destructive

    Update Opportunity Status

    Update Opportunity Status

    PUT /opportunities/{id}/status

Followers

  • Write

    Add Followers

    Add Followers

    POST /opportunities/{id}/followers

  • Write

    Add Followers

    Add Followers

    POST /contacts/{contactId}/followers

  • Destructive

    Remove Followers

    Allows removal of one or all followers from an opportunity.

    DELETE /opportunities/{id}/followers

  • Destructive

    Remove Followers

    Remove Followers

    DELETE /contacts/{contactId}/followers

Object Schema

  • Read

    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, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

    GET /objects/{key}

  • Read

    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 : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

    GET /objects/

  • Write

    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/

  • Destructive

    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 : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

    PUT /objects/{key}

Records

  • Read

    Get Record By Id

    Allows you to get a Standard Object like business and custom object record by Id

    GET /objects/{schemaKey}/records/{id}

  • Write

    Create Record

    Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

    POST /objects/{schemaKey}/records

  • Destructive

    Update Record

    Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

    PUT /objects/{schemaKey}/records/{id}

  • Destructive

    Delete Record

    Delete Record By Id . Supported Objects are business and custom objects.

    DELETE /objects/{schemaKey}/records/{id}

Search Object Records

  • Read

    Search Object Records

    Supported Objects are custom objects and standard objects like "business". Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-379336

    POST /objects/{schemaKey}/records/search

OAuth 2.0

  • Read

    Get Location where app is installed

    This API allows you fetch location where app is installed upon

    GET /oauth/installed-locations

  • Read

    Get Location where app is installed

    This API allows you fetch location where app is installed upon

    GET /oauth/installedLocations

  • Write

    Get Access Token

    Use Access Tokens to access CRM resources on behalf of an authenticated location/company.

    POST /oauth/token

  • Write

    Get Location Access Token from Agency Token

    This API allows you to generate locationAccessToken from AgencyAccessToken

    POST /oauth/location-token

  • Write

    Get Location Access Token from Agency Token

    This API allows you to generate locationAccessToken from AgencyAccessToken

    POST /oauth/locationToken

Medias

  • Read

    Get List of Files/ Folders

    Fetches list of files and folders from the media storage

    GET /medias/files

  • Write

    Upload File into Media Storage

    If hosted is set to true then fileUrl is required. Else file is required. If adding a file, maximum allowed is 25 MB. For video files, the maximum allowed size is 500 MB.

    POST /medias/upload-file

  • Write

    Update File/ Folder

    Updates a single file or folder by ID

    POST /medias/{id}

  • Write

    Create Folder

    Creates a new folder in the media storage

    POST /medias/folder

  • Destructive

    Delete File or Folder

    Deletes specific file or folder from the media storage

    DELETE /medias/{id}

  • Destructive

    Bulk Update Files/ Folders

    Updates metadata or status of multiple files and folders

    PUT /medias/update-files

  • Destructive

    Bulk Delete / Trash Files or Folders

    Soft-deletes or trashes multiple files and folders in a single request

    PUT /medias/delete-files

Wallet Charges

  • Read

    Get all wallet charges

    Get all wallet charges

    GET /marketplace/billing/charges

  • Read

    Get specific wallet charge details

    Get specific wallet charge details

    GET /marketplace/billing/charges/{chargeId}

  • Read

    Check if account has sufficient funds

    Check if account has sufficient funds

    GET /marketplace/billing/charges/has-funds

  • Write

    Create a new wallet charge

    Create a new wallet charge

    POST /marketplace/billing/charges

  • Destructive

    Delete a wallet charge

    Delete a wallet charge

    DELETE /marketplace/billing/charges/{chargeId}

App Management

  • Read

    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

  • Destructive

    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

App Billing Management

  • Read

    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}

External Auth Migration

  • Write

    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 lifecycle of the token is managed by CRM.

    POST /marketplace/external-auth/migration

Sub Account (Formerly Location)

  • Read

    Get Sub-Account (Formerly Location)

    Get details of a Sub-Account (Formerly Location) by passing the sub-account id

    GET /locations/{locationId}

  • Write

    Create Sub-Account (Formerly Location)

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

    POST /locations/

  • Destructive

    Put Sub-Account (Formerly Location)

    Update a Sub-Account (Formerly Location) based on the data provided

    PUT /locations/{locationId}

  • Destructive

    Delete Sub-Account (Formerly Location)

    Delete a Sub-Account (Formerly Location) from the Agency

    DELETE /locations/{locationId}

Permissions

  • Read

    Get Permissions

    Get Sub-Account (Formerly Location) permissions

    GET /locations/{locationId}/permissions

  • Destructive

    Update Permissions

    Update Sub-Account (Formerly Location) permissions

    PUT /locations/{locationId}/permissions

Tags

  • Read

    Get Tags

    Get Sub-Account (Formerly Location) Tags

    GET /locations/{locationId}/tags

  • Read

    Get tag by id

    Get tag by id

    GET /locations/{locationId}/tags/{tagId}

  • Write

    Create Tag

    Create tag

    POST /locations/{locationId}/tags

  • Write

    Add Tags

    Add Tags

    POST /contacts/{contactId}/tags

  • Destructive

    Update tag

    Update tag

    PUT /locations/{locationId}/tags/{tagId}

  • Destructive

    Delete tag

    Delete tag

    DELETE /locations/{locationId}/tags/{tagId}

  • Destructive

    Remove Tags

    Remove Tags

    DELETE /contacts/{contactId}/tags

Tasks Search

Recurring Tasks

  • Read

    Get Recurring Task By Id

    Get Recurring Task By Id

    GET /locations/{locationId}/recurring-tasks/{id}

  • Write

    Create Recurring Task

    Create Recurring Task

    POST /locations/{locationId}/recurring-tasks

  • Destructive

    Update Recurring Task

    Update Recurring Task

    PUT /locations/{locationId}/recurring-tasks/{id}

  • Destructive

    Delete Recurring Task

    Delete Recurring Task

    DELETE /locations/{locationId}/recurring-tasks/{id}

Custom Field

  • Read

    Get Custom Fields

    Get Custom Fields

    GET /locations/{locationId}/customFields

  • Read

    Get Custom Field

    Get Custom Field

    GET /locations/{locationId}/customFields/{id}

  • Write

    Create Custom Field

    Create Custom Field

    POST /locations/{locationId}/customFields

  • Write

    Uploads File to customFields

    Uploads File to customFields

    POST /locations/{locationId}/customFields/upload

  • Destructive

    Update Custom Field

    Update Custom Field

    PUT /locations/{locationId}/customFields/{id}

  • Destructive

    Delete Custom Field

    Delete Custom Field

    DELETE /locations/{locationId}/customFields/{id}

Custom Value

  • Read

    Get Custom Values

    Get Custom Values

    GET /locations/{locationId}/customValues

  • Read

    Get Custom Value

    Get Custom Value

    GET /locations/{locationId}/customValues/{id}

  • Write

    Create Custom Value

    Create Custom Value

    POST /locations/{locationId}/customValues

  • Destructive

    Update Custom Value

    Update Custom Value

    PUT /locations/{locationId}/customValues/{id}

  • Destructive

    Delete Custom Value

    Delete Custom Value

    DELETE /locations/{locationId}/customValues/{id}

Timezone

  • Read

    Fetch Timezones

    Fetch the available timezones

    GET /locations/{locationId}/timezones

Template

  • Read

    GET all or email/sms templates

    GET all or email/sms templates

    GET /locations/{locationId}/templates

  • Read

    List templates

    API to get list of templates

    GET /invoices/template

  • Read

    Get an template

    API to get an template by template id

    GET /invoices/template/{templateId}

  • Write

    Create template

    API to create a template

    POST /invoices/template

  • Write

    Update template late fees configuration

    API to update template late fees configuration by template id

    PATCH /invoices/template/{templateId}/late-fees-configuration

  • Write

    Update template late fees configuration

    API to update template late fees configuration by template id

    PATCH /invoices/template/{templateId}/payment-methods-configuration

  • Destructive

    DELETE an email/sms template

    DELETE an email/sms template

    DELETE /locations/{locationId}/templates/{id}

  • Destructive

    Update template

    API to update an template by template id

    PUT /invoices/template/{templateId}

  • Destructive

    Delete template

    API to update an template by template id

    DELETE /invoices/template/{templateId}

Conversation Channel

  • Read

    Get Conversation Channel

    Get the conversation channel providers configured for a location by type (SMS or Email)

    GET /locations/{locationId}/conversationChannels/{type}

Trigger Links

Trigger Links Search

Faqs

  • Read

    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

  • Write

    Create a new FAQ inside knowledge base

    POST /knowledge-bases/faqs

    POST /knowledge-bases/faqs

  • Destructive

    Update an existing knowledge base FAQ

    PUT /knowledge-bases/faqs/{id}

    PUT /knowledge-bases/faqs/{id}

  • Destructive

    Delete an existing knowledge base FAQ

    DELETE /knowledge-bases/faqs/{id}

    DELETE /knowledge-bases/faqs/{id}

Web Crawler

  • Read

    Get all trained page links by knowledge base

    GET /knowledge-bases/crawler

    GET /knowledge-bases/crawler

  • Read

    Get crawling status for the latest operation

    GET /knowledge-bases/crawler/status

    GET /knowledge-bases/crawler/status

  • Write

    Start crawling and discover pages for training

    POST /knowledge-bases/crawler

    POST /knowledge-bases/crawler

  • Write

    Train discovered website pages and ingest into the knowledge base

    POST /knowledge-bases/crawler/train

    POST /knowledge-bases/crawler/train

  • Destructive

    Delete trained pages

    DELETE /knowledge-bases/crawler

    DELETE /knowledge-bases/crawler

Knowledge Base

  • Read

    Get knowledge base by ID

    GET /knowledge-bases/{knowledgeBaseId}

    GET /knowledge-bases/{knowledgeBaseId}

  • Read

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

    GET /knowledge-bases/

    GET /knowledge-bases/

  • Write

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

    POST /knowledge-bases/

    POST /knowledge-bases/

  • Destructive

    Delete a knowledge base

    DELETE /knowledge-bases/{knowledgeBaseId}

    DELETE /knowledge-bases/{knowledgeBaseId}

  • Destructive

    Update a knowledge base

    PUT /knowledge-bases/{id}

    PUT /knowledge-bases/{id}

Schedule

  • Read

    List schedules

    API to get list of schedules

    GET /invoices/schedule

  • Read

    Get an schedule

    API to get an schedule by schedule id

    GET /invoices/schedule/{scheduleId}

  • Write

    Create Invoice Schedule

    API to create an invoice Schedule

    POST /invoices/schedule

  • Write

    Update scheduled recurring invoice

    API to update scheduled recurring invoice

    POST /invoices/schedule/{scheduleId}/updateAndSchedule

  • Write

    Schedule an schedule invoice

    API to schedule an schedule invoice to start sending to the customer

    POST /invoices/schedule/{scheduleId}/schedule

  • Write

    Manage Auto payment for an schedule invoice

    API to manage auto payment for a schedule

    POST /invoices/schedule/{scheduleId}/auto-payment

  • Destructive

    Update schedule

    API to update an schedule by schedule id

    PUT /invoices/schedule/{scheduleId}

  • Destructive

    Delete schedule

    API to delete an schedule by schedule id

    DELETE /invoices/schedule/{scheduleId}

  • Destructive

    Cancel an scheduled invoice

    API to cancel a scheduled invoice by schedule id

    POST /invoices/schedule/{scheduleId}/cancel

Text2Pay

  • Write

    Create & Send

    API to create or update a text2pay invoice

    POST /invoices/text2pay

Invoice

  • Read

    Generate Invoice Number

    Get the next invoice number for the given location

    GET /invoices/generate-invoice-number

  • Read

    Get Invoice Settings

    Get the invoice settings for the given location

    GET /invoices/settings

  • Read

    Get invoice

    API to get invoice by invoice id

    GET /invoices/{invoiceId}

  • Read

    List invoices

    API to get list of invoices

    GET /invoices/

  • Write

    Update invoice late fees configuration

    API to update invoice late fees configuration by invoice id

    PATCH /invoices/{invoiceId}/late-fees-configuration

  • Write

    Send invoice

    API to send invoice by invoice id

    POST /invoices/{invoiceId}/send

  • Write

    Record a manual payment for an invoice

    API to record manual payment for an invoice by invoice id

    POST /invoices/{invoiceId}/record-payment

  • Write

    Update invoice last visited at

    API to update invoice last visited at by invoice id

    PATCH /invoices/stats/last-visited-at

  • Write

    Create Invoice

    API to create an invoice

    POST /invoices/

  • Destructive

    Update invoice

    API to update invoice by invoice id

    PUT /invoices/{invoiceId}

  • Destructive

    Delete invoice

    API to delete invoice by invoice id

    DELETE /invoices/{invoiceId}

  • Destructive

    Void invoice

    API to delete invoice by invoice id

    POST /invoices/{invoiceId}/void

Estimate

  • Read

    Generate Estimate Number

    Get the next estimate number for the given location

    GET /invoices/estimate/number/generate

  • Read

    List Estimates

    Get a paginated list of estimates

    GET /invoices/estimate/list

  • Read

    List Estimate Templates

    Get a list of estimate templates or a specific template by ID

    GET /invoices/estimate/template

  • Read

    Preview Estimate Template

    Get a preview of an estimate template

    GET /invoices/estimate/template/preview

  • Write

    Create New Estimate

    Create a new estimate with the provided details

    POST /invoices/estimate

  • Write

    Send Estimate

    API to send estimate by estimate id

    POST /invoices/estimate/{estimateId}/send

  • Write

    Create Invoice from Estimate

    Create a new invoice from an existing estimate

    POST /invoices/estimate/{estimateId}/invoice

  • Write

    Update estimate last visited at

    API to update estimate last visited at by estimate id

    PATCH /invoices/estimate/stats/last-visited-at

  • Write

    Create Estimate Template

    Create a new estimate template

    POST /invoices/estimate/template

  • Destructive

    Update Estimate

    Update an existing estimate with new details

    PUT /invoices/estimate/{estimateId}

  • Destructive

    Delete Estimate

    Delete an existing estimate

    DELETE /invoices/estimate/{estimateId}

  • Destructive

    Update Estimate Template

    Update an existing estimate template

    PUT /invoices/estimate/template/{templateId}

  • Destructive

    Delete Estimate Template

    Delete an existing estimate template

    DELETE /invoices/estimate/template/{templateId}

Redirect

  • Read

    Fetch List of Redirects

    Retrieves a list of all URL redirects based on the given query parameters.

    GET /funnels/lookup/redirect/list

  • Write

    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

  • Write

    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}

  • Destructive

    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}

Funnel

  • Read

    Fetch List of Funnels

    Retrieves a list of all funnels based on the given query parameters.

    GET /funnels/funnel/list

  • Read

    Fetch list of funnel pages

    Retrieves a list of all funnel pages based on the given query parameters.

    GET /funnels/page

  • Read

    Fetch count of funnel pages

    Retrieves count of all funnel pages based on the given query parameters.

    GET /funnels/page/count

Forms

  • Read

    Get Forms Submissions

    Get Forms Submissions

    GET /forms/submissions

  • Read

    Get Forms

    Get Forms

    GET /forms/

  • Write

    Upload files to custom fields

    Post the necessary fields for the API to upload files. The files need to be a buffer with the key " ". Here custom field id is the ID of your custom field and file id is a randomly generated id (or uuid) There is support for multiple file uploads as well. Have multiple fields in the format mentioned. File size is limited to 50 MB. The allowed file types are: PDF DOCX DOC JPG JPEG PNG GIF CSV XLSX XLS MP4 MPEG ZIP RAR TXT SVG The API will return the updated contact object.

    POST /forms/upload-custom-files

Campaigns

  • Read

    List Email Campaigns

    Get list of email campaigns for a location

    GET /emails/locations/{locationId}/campaigns/emails

  • Read

    Get Email Campaign by ID

    Get a single email campaign by its ID

    GET /emails/locations/{locationId}/campaigns/emails/{campaignId}

  • Read

    List Workflow Campaigns

    Get list of workflow campaigns for a location

    GET /emails/locations/{locationId}/campaigns/workflows

  • Read

    Get Workflow Campaign by ID

    Get a single workflow campaign by its ID

    GET /emails/locations/{locationId}/campaigns/workflows/{campaignId}

  • Read

    List Bulk Action Campaigns

    Get list of bulk action campaigns for a location

    GET /emails/locations/{locationId}/campaigns/bulk-actions

  • Read

    Get Bulk Action Campaign by ID

    Get a single bulk action campaign by its ID

    GET /emails/locations/{locationId}/campaigns/bulk-actions/{campaignId}

  • Read

    Get Campaigns

    Get Campaigns

    GET /campaigns/

  • Read

    Get Campaigns

    Get Campaigns

    GET /emails/schedule

  • Write

    Create Email Campaign

    Create a new email campaign

    POST /emails/locations/{locationId}/campaigns/emails

  • Write

    Update Email Campaign

    Update an email campaign draft

    PATCH /emails/locations/{locationId}/campaigns/emails/{campaignId}

  • Write

    Schedule Campaign

    Schedule or start an email campaign. The campaign must be in draft, cancelled, or paused status.

    POST /emails/locations/{locationId}/campaigns/emails/{campaignId}/schedule

  • Write

    Add Contact to Campaign

    Add contact to Campaign

    POST /contacts/{contactId}/campaigns/{campaignId}

  • Destructive

    Delete Campaign

    Delete a campaign

    DELETE /emails/locations/{locationId}/campaigns/emails/{campaignId}

  • Destructive

    Remove Contact From Campaign

    Remove Contact From Campaign

    DELETE /contacts/{contactId}/campaigns/{campaignId}

  • Destructive

    Remove Contact From Every Campaign

    Removes the contact from every campaign it is enrolled in.

    DELETE /contacts/{contactId}/campaigns/remove-all

  • Destructive

    Remove Contact From Every Campaign

    Remove Contact From Every Campaign

    DELETE /contacts/{contactId}/campaigns/removeAll

Email Verification

  • Write

    Email Verification

    Verify Email

    POST /email/verify

Custom Menu Links

  • Read

    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}

  • Read

    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 query parameters for filtering, sorting, and pagination.

    GET /custom-menus/

  • Write

    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/

  • Destructive

    Update Custom Menu Link

    Updates an existing custom menu for a given company. Requires authentication and proper permissions.

    PUT /custom-menus/{customMenuId}

  • Destructive

    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}

Custom Fields V2

  • Read

    Get Custom Field / Folder By Id

    Get Custom Field / Folder By Id. :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    GET /custom-fields/{id}

  • Read

    Get Custom Fields By Object Key

    Get Custom Fields By Object Key :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    GET /custom-fields/object-key/{objectKey}

  • Write

    Create Custom Field Folder

    Create Custom Field Folder :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    POST /custom-fields/folder

  • Write

    Create Custom Field

    Create Custom Field :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    POST /custom-fields/

  • Destructive

    Update Custom Field By Id

    Update Custom Field By Id :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    PUT /custom-fields/{id}

  • Destructive

    Delete Custom Field By Id

    Delete Custom Field By Id :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    DELETE /custom-fields/{id}

  • Destructive

    Update Custom Field Folder Name

    Create Custom Field Folder :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    PUT /custom-fields/folder/{id}

  • Destructive

    Delete Custom Field Folder

    Create Custom Field Folder :::info Only supports Custom Objects and Company (Business) today. Will be extended to other Standard Objects in the future. :::

    DELETE /custom-fields/folder/{id}

Courses

  • Write

    Import Courses

    Import Courses through public channels

    POST /courses/courses-exporter/public/import

Conversations

  • Read

    Get Conversation

    Get the conversation details based on the conversation ID

    GET /conversations/{conversationId}

  • Write

    Create Conversation

    Creates a new conversation with the data provided

    POST /conversations/

  • Destructive

    Update Conversation

    Update the conversation details based on the conversation ID

    PUT /conversations/{conversationId}

  • Destructive

    Delete Conversation

    Delete the conversation details based on the conversation ID

    DELETE /conversations/{conversationId}

Email

  • Read

    Get email by Id

    Get email by Id

    GET /conversations/messages/email/{id}

  • Destructive

    Cancel a scheduled email message.

    Post the messageId for the API to delete a scheduled email message.

    DELETE /conversations/messages/email/{emailMessageId}/schedule

  • Destructive

    Update email message status

    Update delivery events, per-recipient statuses, and the overall message status for an email sent via a custom conversation provider. Authorization - Requires the conversations/message.write OAuth scope. - The calling OAuth app must own the conversation provider that originally sent the email. - Attempts to update emails sent via LC Email or Mailgun will return 403 Forbidden. Updatable Fields status is required on every request. You may also include events and/or recipients. events — Aggregate delivery event counters (integers). Counters are merged into the existing values (not replaced). Setting a counter to 0 is treated as no-op and will not reset the stored value. recipients — Per-recipient delivery statuses. Each entry maps a recipient email address to a MessageStatus value. Use failReason to capture bounce or rejection details when the status is failed. status — The overall message status. Accepts any MessageStatus enum value. Event Inference The API automatically infers related events to maintain data consistency: - clicked, complained, unsubscribed, or replied → implies opened (set to 1 if not already provided and open tracking is enabled) and delivered (set to 1). - opened → implies delivered (set to 1 if not provided). - delivered, permanentfail, or temporaryfail → implies accepted (set to 1 if not provided). Timestamps The API automatically records server-side timestamps on first occurrence for delivered, opened, and clicked events. Subsequent updates to these counters do not overwrite the original timestamp.

    PUT /conversations/messages/email/{id}/status

Messages

  • Read

    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 returned including activity messages (opportunity updates, appointments, etc.).

    GET /conversations/messages/export

  • Read

    Get message by message id

    Get message by message id.

    GET /conversations/messages/{id}

  • Read

    Get messages by conversation id

    Get messages by conversation id.

    GET /conversations/{conversationId}/messages

  • Read

    Get Recording by Message ID

    Get the recording for a message by passing the message id

    GET /conversations/messages/{messageId}/locations/{locationId}/recording

  • Read

    Get transcription by Message ID

    Get the recording transcription for a message by passing the message id

    GET /conversations/locations/{locationId}/messages/{messageId}/transcription

  • Read

    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

  • Write

    Send a new message

    Post the necessary fields for the API to send a new message.

    POST /conversations/messages

  • Write

    Add an inbound message

    Post the necessary fields for the API to add a new inbound message.

    POST /conversations/messages/inbound

  • Write

    Add an external outbound call

    Post the necessary fields for the API to add a new outbound call.

    POST /conversations/messages/outbound

  • Write

    Upload file attachments

    Post the necessary fields for the API to upload files. The files need to be a buffer with the key "fileAttachment". The allowed file types are: JPG JPEG PNG MP4 MPEG ZIP RAR PDF DOC DOCX TXT MP3 WAV The API will return an object with the URLs

    POST /conversations/messages/upload

  • Write

    Send a review reply to Google My Business (deprecated)

    Post a reply to a customer review on Google My Business This endpoint is internal-only and is not supported for OAuth or public API integrations. It will be removed from the public OpenAPI specification in a future release.

    POST /conversations/messages/review-reply

  • Write

    Initiate file upload to GCS (deprecated)

    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. This endpoint is internal-only and is not supported for OAuth or public API integrations. It will be removed from the public OpenAPI specification in a future release.

    POST /conversations/messages/upload/initiate

  • Write

    Complete file upload (deprecated)

    Validates the uploaded file in GCS and returns the public URL. Call this endpoint after successfully uploading the file to the signed URL. This endpoint is internal-only and is not supported for OAuth or public API integrations. It will be removed from the public OpenAPI specification in a future release.

    POST /conversations/messages/upload/complete

  • Destructive

    Cancel a scheduled message.

    Post the messageId for the API to delete a scheduled message.

    DELETE /conversations/messages/{messageId}/schedule

  • Destructive

    Update message status

    Post the necessary fields for the API to update message status.

    PUT /conversations/messages/{messageId}/status

  • Destructive

    Add message attachments

    Set attachments on an existing message (replaces existing). Maximum 5 URLs. Supported for TYPECUSTOMCALL (34) and TYPECALL (1) with subType EXTERNALCALL.

    PUT /conversations/messages/{messageId}/attachments

Providers

  • Write

    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

Generations

  • Read

    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

Tasks

  • Read

    Get all Tasks

    Get all Tasks

    GET /contacts/{contactId}/tasks

  • Read

    Get Task

    Get Task

    GET /contacts/{contactId}/tasks/{taskId}

  • Write

    Create Task

    Create Task

    POST /contacts/{contactId}/tasks

  • Destructive

    Update Task

    Update Task

    PUT /contacts/{contactId}/tasks/{taskId}

  • Destructive

    Delete Task

    Delete Task

    DELETE /contacts/{contactId}/tasks/{taskId}

  • Destructive

    Update Task Completed

    Update Task Completed

    PUT /contacts/{contactId}/tasks/{taskId}/completed

Appointments

  • Read

    Get Appointments for Contact

    Get Appointments for Contact

    GET /contacts/{contactId}/appointments

Notes

  • Read

    Get All Notes

    Get All Notes

    GET /contacts/{contactId}/notes

  • Read

    Get Note

    Get Note

    GET /contacts/{contactId}/notes/{id}

  • Write

    Create Note

    Create Note

    POST /contacts/{contactId}/notes

  • Destructive

    Update Note

    Update Note

    PUT /contacts/{contactId}/notes/{id}

  • Destructive

    Delete Note

    Delete Note

    DELETE /contacts/{contactId}/notes/{id}

Bulk

  • Destructive

    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}

  • Destructive

    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

Contacts

  • Read

    Get Contact

    Retrieves a contact by its unique identifier.

    GET /contacts/{contactId}

  • Read

    Get Contacts By BusinessId

    Get Contacts By BusinessId

    GET /contacts/business/{businessId}

  • Read

    Get Contacts (deprecated)

    Get Contacts Note: This API endpoint is deprecated. Please use the Search Contacts endpoint instead.

    GET /contacts/

  • Write

    Upsert Contact

    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 Email and Phone, the API will attempt to identify an existing contact based on the priority sequence specified in the setting, and will create or update the contact accordingly. If two separate contacts already exist—one with the same email and another with the same phone—and an upsert request includes both the email and phone, the API will update the contact that matches the first field in the configured sequence, and ignore the second field to prevent duplication.

    POST /contacts/upsert

  • Write

    Create Contact

    Create a new contact

    POST /contacts/

  • Destructive

    Update Contact

    Update a contact using contactId

    PUT /contacts/{contactId}

  • Destructive

    Delete Contact

    Delete Contact

    DELETE /contacts/{contactId}

Workflow

  • Write

    Add Contact to Workflow

    Add Contact to Workflow

    POST /contacts/{contactId}/workflow/{workflowId}

  • Destructive

    Delete Contact from Workflow

    Delete Contact from Workflow

    DELETE /contacts/{contactId}/workflow/{workflowId}

Companies

  • Read

    Get Company

    Get Comapny

    GET /companies/{companyId}

Chat Widget

  • Read

    List Chat Widgets

    Returns chat widgets for the sub-account with pagination and optional filters.

    GET /chat-widget/list

  • Read

    Get Chat Widget

    Returns a single chat widget by ID.

    GET /chat-widget/data/{locationId}/{id}

  • Read

    Get Widget Config

    Returns widget configuration by ID.

    GET /chat-widget/public/config/{id}

  • Write

    Patch Chat Widget

    Partial update of a chat widget resource.

    PATCH /chat-widget/data/{locationId}/{id}

  • Write

    Clone Chat Widget

    Creates a copy of an existing chat widget in the same sub-account.

    POST /chat-widget/clone

  • Write

    Create Chat Widget

    Creates a new chat widget for the given sub-account.

    POST /chat-widget/

  • Destructive

    Update Chat Widget

    Full update of a chat widget resource.

    PUT /chat-widget/data/{locationId}/{id}

  • Destructive

    Delete Chat Widget

    Soft-deletes a chat widget. If it was the default, another widget may be promoted.

    DELETE /chat-widget/{locationId}/{id}

Calendar Groups

  • Read

    Get Groups

    Get all calendar groups in a location.

    GET /calendars/groups

  • Read

    Validate group slug

    Validate if group slug is available or not.

    POST /calendars/groups/validate-slug

  • Write

    Create Calendar Group

    Create Calendar Group

    POST /calendars/groups

  • Destructive

    Update Group

    Update Group by group ID

    PUT /calendars/groups/{groupId}

  • Destructive

    Delete Group

    Delete Group

    DELETE /calendars/groups/{groupId}

  • Destructive

    Disable Group

    Disable Group

    PUT /calendars/groups/{groupId}/status

Service Bookings

  • Read

    Get Service Bookings

    Retrieve service bookings for a location within a given date range, with an optional service location filter.

    GET /calendars/services/bookings

  • Read

    Get Service Booking by ID

    Get a specific service booking by ID

    GET /calendars/services/bookings/{bookingId}

  • Write

    Create Service Booking

    Create a new service booking

    POST /calendars/services/bookings

  • Destructive

    Update Service Booking

    Update an existing service booking

    PUT /calendars/services/bookings/{bookingId}

  • Destructive

    Delete Service Booking

    Delete a service booking by ID

    DELETE /calendars/services/bookings/{bookingId}

Services

  • Read

    Get Services

    Get all services in a location.

    GET /calendars/services/catalog

  • Read

    Get Service by ID

    Get service by ID.

    GET /calendars/services/catalog/{serviceId}

  • Write

    Create Service

    Create new service in a location.

    POST /calendars/services/catalog

  • Destructive

    Update Service

    Update service by ID.

    PUT /calendars/services/catalog/{serviceId}

  • Destructive

    Delete Service

    Delete service by ID.

    DELETE /calendars/services/catalog/{serviceId}

Service Locations

  • Read

    Get Service Locations

    Get all service locations

    GET /calendars/services/locations

  • Read

    Get Service Location by ID

    Get service location by ID

    GET /calendars/services/locations/{serviceLocationId}

  • Write

    Create Service Location

    Create a new service location

    POST /calendars/services/locations

  • Destructive

    Update Service Location

    Update an existing service location

    PUT /calendars/services/locations/{serviceLocationId}

  • Destructive

    Delete Service Location

    Delete a service location by ID

    DELETE /calendars/services/locations/{serviceLocationId}

Calendar Events

  • Read

    Get Appointment

    Get appointment by ID

    GET /calendars/events/appointments/{eventId}

  • Read

    Get Calendar Events

    Get Calendar Events

    GET /calendars/events

  • Read

    Get Blocked Slots

    Get Blocked Slots

    GET /calendars/blocked-slots

  • Write

    Create appointment

    Create appointment

    POST /calendars/events/appointments

  • Write

    Create Block Slot

    Create block slot

    POST /calendars/events/block-slots

  • Destructive

    Update Appointment

    Update appointment

    PUT /calendars/events/appointments/{eventId}

  • Destructive

    Update Block Slot

    Update block slot by ID

    PUT /calendars/events/block-slots/{eventId}

  • Destructive

    Delete Event

    Delete event by ID

    DELETE /calendars/events/{eventId}

Calendars

  • Read

    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

  • Read

    Get Calendar

    Get calendar by ID

    GET /calendars/{calendarId}

  • Read

    Get Calendars

    Get all calendars in a location.

    GET /calendars/

  • Write

    Create Calendar

    Create calendar in a location.

    POST /calendars/

  • Destructive

    Update Calendar

    Update calendar by ID.

    PUT /calendars/{calendarId}

  • Destructive

    Delete Calendar

    Delete calendar by ID

    DELETE /calendars/{calendarId}

Appointment Notes

  • Read

    Get Notes

    Get Appointment Notes

    GET /calendars/appointments/{appointmentId}/notes

  • Write

    Create Note

    Create Note

    POST /calendars/appointments/{appointmentId}/notes

  • Destructive

    Update Note

    Update Note

    PUT /calendars/appointments/{appointmentId}/notes/{noteId}

  • Destructive

    Delete Note

    Delete Note

    DELETE /calendars/appointments/{appointmentId}/notes/{noteId}

Calendar Resources: Rooms & Equipments

  • Read

    Get Calendar Resource (deprecated)

    Get calendar resource by ID (Services V1)

    GET /calendars/resources/{resourceType}/{id}

  • Read

    List Calendar Resources (deprecated)

    List calendar resources by resource type and location ID (Services V1)

    GET /calendars/resources/{resourceType}

  • Write

    Create Calendar Resource (deprecated)

    Create calendar resource by resource type (Services V1)

    POST /calendars/resources/{resourceType}

  • Destructive

    Update Calendar Resource (deprecated)

    Update calendar resource by ID (Services V1)

    PUT /calendars/resources/{resourceType}/{id}

  • Destructive

    Delete Calendar Resource (deprecated)

    Delete calendar resource by ID (Services V1)

    DELETE /calendars/resources/{resourceType}/{id}

Calendar Notifications

  • Read

    Get notifications

    Get calendar notifications based on query

    GET /calendars/{calendarId}/notifications

  • Read

    Get notification

    Find Event notification by notificationId

    GET /calendars/{calendarId}/notifications/{notificationId}

  • Write

    Create notification

    Create Calendar notifications, either one or multiple. All notification settings must be for single calendar only

    POST /calendars/{calendarId}/notifications

  • Destructive

    Update notification

    Update Event notification by id

    PUT /calendars/{calendarId}/notifications/{notificationId}

  • Destructive

    Delete Notification

    Delete notification

    DELETE /calendars/{calendarId}/notifications/{notificationId}

Availability

  • Read

    List user availability schedule

    Retrieve user availability schedules based on various filters including location, calendar, and user. Supports pagination.

    GET /calendars/schedules/search

  • Read

    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}

  • Read

    Get event calendar availability schedule

    Retrieve the availability schedule for a specific event calendar. Returns the schedule associated with the calendar ID provided in the path.

    GET /calendars/schedules/event-calendar/{calendarId}

  • Write

    Create user availability schedule

    Create new schedule with specified rules, timezone, location, user and calendar associations.

    POST /calendars/schedules

  • Write

    Create event calendar availability schedule

    Create a new availability schedule specifically for an event calendar. The calendar ID is provided in the path, and schedule rules and timezone are provided in the request body.

    POST /calendars/schedules/event-calendar/{calendarId}

  • Destructive

    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}

  • Destructive

    Delete user availability schedule

    Permanently remove a schedule and all its associated rules. This action cannot be undone.

    DELETE /calendars/schedules/{id}

  • Destructive

    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}

  • Destructive

    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}

  • Destructive

    Update event calendar availability schedule

    Update the availability schedule for a specific event calendar. Only provided fields will be updated. The calendar ID is provided in the path.

    PUT /calendars/schedules/event-calendar/{calendarId}

Businesses

  • Read

    Get Business

    Get Business

    GET /businesses/{businessId}

  • Read

    Get Businesses by Location

    Get Businesses by Location

    GET /businesses/

  • Write

    Create Business

    Create Business

    POST /businesses/

  • Destructive

    Update Business

    Update Business

    PUT /businesses/{businessId}

  • Destructive

    Delete Business

    Delete Business

    DELETE /businesses/{businessId}

Brand Voices

  • Read

    List Brand Voices

    Get list of brand voices for a location

    GET /brand-boards/locations/{locationId}/brand-voices

  • Read

    Get Brand Voice

    Get a brand voice by ID

    GET /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

  • Write

    Create Brand Voice

    Create a brand voice for a location

    POST /brand-boards/locations/{locationId}/brand-voices

  • Write

    Update Brand Voice

    Update a brand voice by ID

    PATCH /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

  • Write

    Set Default Brand Voice

    Set a brand voice as the default for a location. The previous default will be unset.

    POST /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}/default

  • Destructive

    Delete Brand Voice

    Delete a brand voice by ID

    DELETE /brand-boards/locations/{locationId}/brand-voices/{brandVoiceId}

Brand Boards

  • Read

    Get Brand Boards

    Retrieves all Brand Boards for a specific location

    GET /brand-boards/{locationId}

  • Read

    Get Brand Board

    Retrieves a specific Brand Board by its ID

    GET /brand-boards/{locationId}/{id}

  • Write

    Update a Brand Board

    Updates an existing Brand Board

    PATCH /brand-boards/{locationId}/{id}

  • Write

    Create a new brand board

    Creates a new brand board with logos, colors, and fonts

    POST /brand-boards/

  • Destructive

    Delete a Brand Board

    Deletes a Brand Board

    DELETE /brand-boards/{locationId}/{id}

Blogs

  • Read

    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

  • Read

    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

  • Read

    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

  • Read

    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

  • Read

    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

  • Write

    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

  • Destructive

    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}

Relations

  • Read

    Get all relations By record Id

    Get all relations by record Id

    GET /associations/relations/{recordId}

  • Write

    Create Relation for you associated entities.

    Create Relation.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3

    POST /associations/relations

  • Destructive

    Delete Relation

    Delete Relation

    DELETE /associations/relations/{relationId}

Associations

  • Read

    Get association key by key name

    Using this api you can get standard / user defined association by key

    GET /associations/key/{key_name}

  • Read

    Get association by object keys

    Get association by object keys like contacts, custom objects and opportunities. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3

    GET /associations/objectKey/{objectKey}

  • Read

    Get association by ID

    Using this api you can get SYSTEMDEFINED / USERDEFINED association by id

    GET /associations/{associationId}

  • Read

    Get all associations for a sub-account / location

    Get all Associations

    GET /associations/

  • Write

    Create Association

    Allow you to create contact - contact , contact - custom objects associations, will add more in the future.Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3

    POST /associations/

  • Destructive

    Update Association By Id

    Update Association , Allows you to update labels of an associations. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-293776/cd0f4122abc04d3

    PUT /associations/{associationId}

  • Destructive

    Delete Association

    Delete USERDEFINED Association By Id, deleting an association will also all the relations for that association

    DELETE /associations/{associationId}

Affiliates

  • Read

    List Affiliates

    Retrieve the list of affiliates for a location.

    GET /affiliate-manager/{locationId}/affiliates

  • Read

    Get Affiliate

    Retrieve a single affiliate by id for a location.

    GET /affiliate-manager/{locationId}/affiliates/{affiliateId}

Payouts

  • Read

    List Payouts

    Retrieve the list of payouts for a location.

    GET /affiliate-manager/{locationId}/payouts

Commissions

  • Read

    List Commissions

    Retrieve the list of commissions for a location.

    GET /affiliate-manager/{locationId}/commissions

Facebook Reporting

  • Read

    Get reporting data

    Retrieve aggregated Facebook ad reporting metrics for a location

    GET /ad-publishing/facebook/reporting

  • Read

    Get campaign reporting

    Retrieve reporting metrics for a specific Facebook campaign

    GET /ad-publishing/facebook/reporting/campaign/{campaignId}

  • Read

    Get reporting list

    Retrieve a list of Facebook campaigns, adsets, or ads with reporting data

    GET /ad-publishing/facebook/reporting/list

Facebook Integration

  • Read

    Get current Facebook user

    Retrieve the authenticated Facebook user profile for a location

    GET /ad-publishing/facebook/me

  • Read

    Get Facebook pages

    Retrieve Facebook pages associated with the connected account

    GET /ad-publishing/facebook/pages

  • Read

    Get Instagram accounts for page

    Retrieve Instagram accounts linked to a specific Facebook page

    GET /ad-publishing/facebook/page/{pageId}/instagram

  • Read

    Get page lead forms

    Retrieve lead gen forms for a specific Facebook page

    GET /ad-publishing/facebook/page/{pageId}/forms

  • Read

    Get ad accounts

    Retrieve Facebook ad accounts available for the connected user

    GET /ad-publishing/facebook/ad-accounts

  • Read

    Get ad account details

    Retrieve details of a specific Facebook ad account

    GET /ad-publishing/facebook/ad-accounts/{adAccountId}

  • Read

    Get conversation forms

    Retrieve Facebook conversation lead forms for a location

    GET /ad-publishing/facebook/conversation-forms

  • Read

    Get Facebook integration

    Retrieve the Facebook ad integration details for a location

    GET /ad-publishing/facebook/integration

  • Read

    Get lead form by ID

    Retrieve a specific Facebook lead form by its ID

    GET /ad-publishing/facebook/lead-form/{leadFormId}

  • Write

    Create page lead form

    Create a new lead gen form on a Facebook page

    POST /ad-publishing/facebook/page/{pageId}/forms

  • Write

    Create conversation form

    Create a new Facebook conversation lead form

    POST /ad-publishing/facebook/conversation-forms

  • Write

    Create Facebook integration

    Create a Facebook ad integration for a location with page and ad account

    POST /ad-publishing/facebook/integration

  • Destructive

    Delete ad account

    Remove a Facebook ad account connection from a location

    DELETE /ad-publishing/facebook/ad-accounts/{adAccountId}

  • Destructive

    Delete Facebook integration

    Remove the Facebook ad integration from a location

    DELETE /ad-publishing/facebook/integration

  • Destructive

    Delete page connection

    Remove a Facebook page connection from a location

    DELETE /ad-publishing/facebook/page

  • Destructive

    Set default page

    Set the default Facebook page for a location

    PUT /ad-publishing/facebook/page/default

Facebook Ads

  • Read

    Search targeting options

    Search Facebook geo-locations and interests for ad targeting

    GET /ad-publishing/facebook/targeting/search

  • Read

    Get conversion pixels

    Retrieve Facebook conversion pixels for a location

    GET /ad-publishing/facebook/pixels

  • Read

    Get custom audiences

    Retrieve Facebook custom audiences for a location

    GET /ad-publishing/facebook/custom-audience

  • Read

    Get custom audience by ID

    Retrieve a specific Facebook custom audience by its ID

    GET /ad-publishing/facebook/custom-audience/{audienceId}

  • Read

    Get campaign with linked entities

    Retrieve a Facebook campaign with its linked adsets and ads

    GET /ad-publishing/facebook/campaign/{campaignId}

  • Read

    Get entities

    Retrieve Facebook campaigns, adsets, or ads based on entity type

    GET /ad-publishing/facebook/entity

  • Read

    Get campaign publishing progress

    Returns Redis-backed publish progress for a campaign while it is publishing to Meta. Used by the validation funnel UI to poll step counts and completion state.

    GET /ad-publishing/facebook/campaigns/{campaignId}/publishing-progress

  • Write

    Publish campaign

    Publish a Facebook campaign and push it live to Facebook

    POST /ad-publishing/facebook/campaigns/{campaignId}/publish

  • Write

    Pause campaign

    Pause a running Facebook campaign

    POST /ad-publishing/facebook/campaigns/{campaignId}/pause

  • Write

    Resume campaign

    Resume a paused Facebook campaign

    POST /ad-publishing/facebook/campaigns/{campaignId}/resume

  • Write

    Duplicate campaign

    Duplicate an existing Facebook campaign

    POST /ad-publishing/facebook/campaigns/{campaignId}/duplicate

  • Write

    Pause ad set

    Pause a running Facebook ad set

    POST /ad-publishing/facebook/adsets/{adSetId}/pause

  • Write

    Resume ad set

    Resume a paused Facebook ad set

    POST /ad-publishing/facebook/adsets/{adSetId}/resume

  • Write

    Duplicate ad set

    Duplicate an existing Facebook ad set

    POST /ad-publishing/facebook/adsets/{adSetId}/duplicate

  • Write

    Pause ad

    Pause a running Facebook ad

    POST /ad-publishing/facebook/ads/{adId}/pause

  • Write

    Resume ad

    Resume a paused Facebook ad

    POST /ad-publishing/facebook/ads/{adId}/resume

  • Write

    Duplicate ad

    Duplicate an existing Facebook ad

    POST /ad-publishing/facebook/ads/{adId}/duplicate

  • Destructive

    Upsert conversion pixel

    Create or update a Facebook conversion pixel configuration

    PUT /ad-publishing/facebook/pixels

  • Destructive

    Update custom audience

    Update name or description of a Facebook custom audience

    PUT /ad-publishing/facebook/custom-audience/{audienceId}

  • Destructive

    Delete custom audience

    Delete a Facebook custom audience by ID

    DELETE /ad-publishing/facebook/custom-audience/{audienceId}

  • Destructive

    Add custom audience member

    Add a member to a Facebook custom audience

    PUT /ad-publishing/facebook/custom-audience/{audienceId}/member

  • Destructive

    Remove custom audience member

    Remove a member from a Facebook custom audience

    DELETE /ad-publishing/facebook/custom-audience/{audienceId}/member

  • Destructive

    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

  • Destructive

    Upsert campaign

    Create or update a Facebook campaign

    PUT /ad-publishing/facebook/campaigns

  • Destructive

    Upsert adset

    Create or update a Facebook ad set

    PUT /ad-publishing/facebook/adsets

  • Destructive

    Upsert ad

    Create or update a Facebook ad

    PUT /ad-publishing/facebook/ads

  • Destructive

    Delete campaign

    Delete a Facebook campaign by ID

    DELETE /ad-publishing/facebook/campaigns/{campaignId}

  • Destructive

    Delete ad set

    Delete a Facebook ad set by ID

    DELETE /ad-publishing/facebook/adsets/{adSetId}

  • Destructive

    Delete ad

    Delete a Facebook ad by ID

    DELETE /ad-publishing/facebook/ads/{adId}

  • Destructive

    Upsert ad

    Create or update a Facebook ad (v2)

    PUT /ad-publishing/facebook/ads-v2

Google Reporting

  • Read

    Get reporting data

    Retrieve aggregated Google Ads reporting metrics for a location

    GET /ad-publishing/google/reporting

  • Read

    Get reporting list

    Retrieve a list of Google campaigns or ad groups with reporting data

    GET /ad-publishing/google/reporting/list

  • Read

    Get campaign reporting

    Retrieve reporting metrics for a specific Google campaign

    GET /ad-publishing/google/reporting/campaign/{campaignId}

Google Ads

  • Read

    Get conversions

    Retrieve Google Ads conversion actions for a location

    GET /ad-publishing/google/conversions

  • Read

    Get conversion by ID

    Retrieve a specific Google Ads conversion action by ID

    GET /ad-publishing/google/conversions/{conversionId}

  • Read

    Search targeting options

    Search Google geo-locations for ad targeting

    GET /ad-publishing/google/targeting/search

  • Read

    Get keyword ideas

    Retrieve keyword suggestions for Google Ads campaigns

    POST /ad-publishing/google/keyword-ideas

  • Read

    Get assets

    Retrieve Google Ads creative assets for a location

    GET /ad-publishing/google/assets

  • Read

    Get entities

    Retrieve Google campaigns, ad groups, or ads based on entity type

    GET /ad-publishing/google/entity

  • Read

    Get target interests

    Retrieve affinity and in-market audience options for Google Ads targeting

    GET /ad-publishing/google/target-interests

  • Read

    Get segments

    Retrieve Google Ads audience segments for a location

    GET /ad-publishing/google/segments

  • Read

    Get segment by ID

    Retrieve a specific Google Ads audience segment by ID

    GET /ad-publishing/google/segments/{segmentId}

  • Read

    Get audiences

    Retrieve Google Ads combined audiences for a location

    GET /ad-publishing/google/audiences

  • Read

    Get audience by ID

    Retrieve a specific Google Ads combined audience by ID

    GET /ad-publishing/google/audiences/{audienceId}

  • Read

    Get Google campaign by ID

    Retrieve a specific Google Ads campaign by ID

    GET /ad-publishing/google/ads/{adId}

  • Read

    Get conversion goals

    Retrieve Google Ads conversion goals for a location

    GET /ad-publishing/google/conversion-goals

  • Write

    Publish ad

    Publish a Google ad and push it live

    POST /ad-publishing/google/ads/{adId}/publish

  • Write

    Upsert assets

    Create or update Google Ads creative assets

    POST /ad-publishing/google/assets

  • Write

    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

  • Destructive

    Upsert conversion

    Create or update a Google Ads conversion action

    PUT /ad-publishing/google/conversions

  • Destructive

    Delete conversion

    Delete a Google Ads conversion action by ID

    DELETE /ad-publishing/google/conversions/{conversionId}

  • Destructive

    Upsert segment

    Create or update a Google Ads audience segment

    PUT /ad-publishing/google/segments

  • Destructive

    Delete segment

    Delete a Google Ads audience segment by ID

    DELETE /ad-publishing/google/segments/{segmentId}

  • Destructive

    Upsert audience

    Create or update a Google Ads combined audience

    PUT /ad-publishing/google/audiences

  • Destructive

    Upsert Google campaign

    Create or update a full Google Ads campaign structure

    PUT /ad-publishing/google/ads

Google Integration

  • Read

    Get Google integration

    Retrieve the Google Ads integration details for a location

    GET /ad-publishing/google/integration

  • Read

    Get current Google user

    Retrieve the authenticated Google user info for a location

    GET /ad-publishing/google/me

  • Read

    Get Google ad accounts

    Retrieve Google Ads accounts available for the connected user

    GET /ad-publishing/google/ad-accounts

  • Read

    Get ad account details

    Retrieve details of a specific Google Ads account

    GET /ad-publishing/google/ad-accounts/{adAccountId}

  • Write

    Create Google integration

    Create a Google Ads integration for a location

    POST /ad-publishing/google/integration

  • Destructive

    Delete ad account

    Remove a Google Ads account connection from a location

    DELETE /ad-publishing/google/ad-accounts/{adAccountId}

Linked In Integration

  • Read

    Get LinkedIn integration

    Retrieve the LinkedIn Ads integration details for a location

    GET /ad-publishing/linkedin/integration

  • Read

    Get LinkedIn ad accounts

    Retrieve LinkedIn Ads accounts available for the connected user

    GET /ad-publishing/linkedin/ad-accounts

  • Read

    Get ad account details

    Retrieve details of a specific LinkedIn ad account

    GET /ad-publishing/linkedin/ad-account

  • Read

    Get current LinkedIn user

    Retrieve the authenticated LinkedIn user info for a location

    GET /ad-publishing/linkedin/me

  • Write

    Create LinkedIn integration

    Create a LinkedIn Ads integration for a location with ad account details

    POST /ad-publishing/linkedin/integration

  • Destructive

    Delete ad account

    Remove a LinkedIn ad account connection from a location

    DELETE /ad-publishing/linkedin/ad-account

Linked In Ads

  • Read

    Get ad campaign group

    Retrieve a LinkedIn ad campaign group by ID

    GET /ad-publishing/linkedin/ads/{adId}

  • Read

    Search targeting options

    Search LinkedIn targeting facets such as locations, industries, and job titles

    GET /ad-publishing/linkedin/targeting/search

  • Read

    Get lead forms

    Retrieve LinkedIn lead gen forms for an ad account

    GET /ad-publishing/linkedin/{accountId}/forms

  • Write

    Publish ad campaign group

    Publish a LinkedIn ad campaign group and push it live

    POST /ad-publishing/linkedin/ads/{adId}/publish

  • Write

    Create lead form

    Create a new LinkedIn lead gen form for an ad account

    POST /ad-publishing/linkedin/{accountId}/form

  • Write

    Update ad status

    Pause or resume a LinkedIn ad, campaign, or ad group

    PATCH /ad-publishing/linkedin/{adId}/status

  • Destructive

    Upsert ad campaign group

    Create or update a LinkedIn ad campaign group with campaigns and ads

    PUT /ad-publishing/linkedin/ads

Linked In Reporting

  • Read

    Get ad analytics

    Retrieve LinkedIn Ads analytics data with configurable pivot and time grouping

    GET /ad-publishing/linkedin/reporting

  • Read

    Get reporting list

    Retrieve a list of LinkedIn campaigns or campaign groups with reporting data

    GET /ad-publishing/linkedin/reporting/list

  • Read

    Get campaign group reporting

    Retrieve reporting metrics for a specific LinkedIn campaign group

    GET /ad-publishing/linkedin/reporting/campaign-group/{campaignGroupId}

Preference Management

  • Read

    Get All Custom Subtypes

    Get all custom subtypes for a location

    GET /conversations/preferences/custom-subtypes

  • Read

    Get Contact Unsubscription Status

    Get all subscription statuses for a contact (all emails or specific email)

    GET /conversations/preferences/unsubscriptions/status

  • Write

    Create Custom Subtype

    Create a new custom subtype for a location. Requires agency or account admin role.

    POST /conversations/preferences/custom-subtypes

  • Write

    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 subscriptions.

    POST /conversations/preferences/unsubscriptions/user-change

  • Destructive

    Update Custom Subtype

    Update or archive a custom subtype. Requires agency or account admin role.

    PUT /conversations/preferences/custom-subtypes/{id}

Oauth | Tiktok

  • Read

    Get Tiktok Business profile

    Get Tiktok Business profile

    GET /social-media-posting/oauth/{locationId}/tiktok-business/accounts/{accountId}

  • Read

    Get Tiktok profile

    Get Tiktok profile

    GET /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId}

  • Write

    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 callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "tiktok" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch Tiktok account details using below API - API: '/social-media-posting/oauth/tiktok/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/tiktok/start

  • Write

    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 its callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "tiktok-business" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch Tiktok-Business account details using below API - API: '/social-media-posting/oauth/tiktok-business/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/tiktok-business/start

  • Write

    Attach Tiktok profile

    Attach Tiktok profile

    POST /social-media-posting/oauth/{locationId}/tiktok/accounts/{accountId}

Oauth | Twitter

  • Read

    Get Twitter profile (deprecated)

    ! 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}

  • Write

    Starts OAuth For Twitter Account (deprecated)

    ! As of December 4, 2024, X (formerly Twitter) is no longer supported. We apologise for any inconvenience.

    GET /social-media-posting/oauth/twitter/start

  • Write

    Attach Twitter profile (deprecated)

    ! 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}

Oauth | Linked In

  • Read

    Get Linkedin pages and profile

    Get Linkedin pages and profile

    GET /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId}

  • Write

    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 callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "linkedin" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch LinkedIn account details using below API - API: '/social-media-posting/oauth/linkedin/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/linkedin/start

  • Write

    Attach linkedin pages and profile

    Attach linkedin pages and profile

    POST /social-media-posting/oauth/{locationId}/linkedin/accounts/{accountId}

Oauth | Facebook

  • Read

    Get facebook pages

    Get facebook pages

    GET /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId}

  • Write

    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 callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "facebook" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch Facebook account details using below API - API: '/social-media-posting/oauth/facebook/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/facebook/start

  • Write

    Attach facebook pages

    Attach facebook pages

    POST /social-media-posting/oauth/{locationId}/facebook/accounts/{accountId}

Oauth | Google

  • Read

    Get google business locations

    Get google business locations

    GET /social-media-posting/oauth/{locationId}/google/locations/{accountId}

  • Write

    Set google business locations

    Set google business locations

    POST /social-media-posting/oauth/{locationId}/google/locations/{accountId}

  • Write

    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 callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "google" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch Google account details using below API - API: '/social-media-posting/oauth/google/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/google/start

Oauth | Instagram

  • Read

    Get Instagram Professional Accounts

    Get Instagram Professional Accounts

    GET /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId}

  • Write

    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 callback function. Sample code to listen to event data: window.addEventListener('message', function(e) { if (e.data && e.data.page === 'socialmediaposting') { const { actionType, page, platform, placement, accountId, reconnectAccounts } = e.data } }, false) Event Data Response: { actionType: string, Ex: "close" page: string, Ex: "social-media-posting" platform: string, Ex: "instagram" placement: string, Ex: "placement" accountId: string, Ex: "658a9b6833b91e0ecb8f3958" reconnectAccounts: string[]] Ex: ["658a9b6833b91e0ecb834acd", "efd2daa9b6833b91e0ecb8f3511"] } The accountId retrieved from above data can be used to fetch Instagram account details using below API - API: '/social-media-posting/oauth/instagram/accounts/:accountId' Method: GET

    GET /social-media-posting/oauth/instagram/start

  • Write

    Attach Instagram Professional Accounts

    Attach Instagram Professional Accounts

    POST /social-media-posting/oauth/{locationId}/instagram/accounts/{accountId}

Get started

  1. Open Space settings → Connections and search for Highlevel.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.