ZoomInfo Copilot API

{"openapi":"3.0.0","info":{"title":"Copilot API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"Copilot API for interacting with the Copilot related services."},"tags":[{"name":"Account Summary"},{"name":"Insights"},{"name":"Recommendations"},{"name":"Customer Buyer Persona"},{"name":"Customer Competitors"},{"name":"Ideal Customer Profile"},{"name":"Customer Settings"},{"name":"Products and Services"}],"paths":{"/copilot/v1/companies/{companyId}/account-summary":{"get":{"operationId":"AccountSummaryInterface_getAccountSummary","summary":"Get Account Summary","description":"Retrieve the account summary for a specific company.","parameters":[{"name":"companyId","in":"path","required":true,"description":"The unique identifier of the company","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AccountSummaryResponse"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Account Summary"],"security":[{"OAuth2Auth":["api:account-summary:read"]}],"x-api-roles":["fea:asu"]}},"/copilot/v1/companies/{companyId}/account-summary/actions/ask":{"post":{"operationId":"AccountSummaryInterface_askAccountSummaryQuestion","summary":"Ask Account Summary Question","description":"Ask a question about the account summary of a specific company.","parameters":[{"name":"companyId","in":"path","required":true,"description":"The unique identifier of the company","schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AccountSummaryQuestionResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Account Summary"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AccountSummaryQuestionRequest"}}},"description":"The request body containing the question details."},"security":[{"OAuth2Auth":["api:account-summary:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:cai"]}},"/copilot/v1/companies/insights":{"post":{"operationId":"InsightsInterface_getCompanyInsightsByType","summary":"Get insights by type","description":"Retrieve sales intelligence signals for up to 50 companies, filtered by signal type. Signals include funding events, leadership changes, intent spikes, hiring anomalies, and more.\n\n# Insights API - Introduction\n\nThe **Insights API** provides programmatic access to ZoomInfo's curated intelligence layer — actionable data about customer activity that matters most to your business. **Insights** are automatically filtered for relevance, recency, and context based on your team's specific focus areas. This means you receive high-priority updates like decision-maker job changes at target accounts, intent spikes in your buying groups, or website visits from key personas — without the noise of every global data point.\n\n## Why Use Insights?\n\n**Insights** enable two critical workflows for modern go-to-market teams:\n\n- **Revenue Operations**: Orchestrate automated workflows based on meaningful account changes. For example, route leads when employment changes bring a known champion to a target account, send alerts when intent signals spike for your product category, or update CRM records when funding announcements or new projects signal budget availability.\n\n- **Sales Teams**: Prioritize accounts based on key buying signals, and reach out in real time. Focus on accounts where specific decision-makers have visited your website, where intent data shows they're actively researching competitors, or where employment changes indicate new leadership in key buying roles — all without sifting through irrelevant updates.\n\n## Data Sources\n\n**Insights** are powered by multiple data sources, including:\n\n- **ZoomInfo Data**: Intent signals, WebSights visitor intelligence, organizational changes, and business news from public sources\n- **First-Party Data**: CRM activity, meeting intelligence, and email engagement from your systems\n- **Partner Signals**: Buyer intent and product research activity from G2, TrustRadius, and other platforms\n\n## Available Insight Types\n\nFor a complete list of available Insights and their filtering criteria, see the [ZoomInfo Signals Glossary](https://eng7e.seismic.com/i/7PLUSSIGNTOIgJwEd0YNcFquYltStcWzmeup___own6jqymt85zpqZZ9Ml9dbioKdxvA1oAnox7K5rO5cIjVfG5FnDjPSyasqgaogzeKTK___iPLUSSIGNQTfCOy3CcvhCmqnpK9yYiDadIILi).\n\n## Common Use Cases\n\nThe Insights API empowers you to surface and act on customer intelligence in any application or workflow that makes sense for your business:\n\n- **Account Prioritization & Routing**: Orchestrate scoring, segmentation, and assignment workflows that connect insights across systems to route accounts to the right sellers at the right time\n- **Workflow Automation**: Trigger external systems like email platforms, notification tools, or data warehouses when specific insight types occur\n- **Real-Time Alerting**: Create custom notification rules based on your team's unique prioritization logic\n- **Custom Dashboards**: Build executive views of high-priority account activity across your entire portfolio","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanyInsightsByTypeResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Insights"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanyInsightsByTypeRequest"}}},"description":"The request body containing company IDs(mandatory) and insight type filters."},"security":[{"OAuth2Auth":["api:insights:read"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:gtmpl"]}},"/copilot/v1/companies/lookalikes":{"get":{"operationId":"CompanyLookalikesInterface_companyLookalikes","summary":"Find Similar Companies","description":"Company Lookalikes can be used to retrieve a ranked list of companies that are similar to a given reference company.\nThe similar companies are identified using a machine learning model that analyzes industry, revenue range, employee count, and other firmographic signals.\nThese lookalike companies can be used to power prospecting, territory planning, or market expansion workflows where one wants to quickly find companies that \"look like\" a\nsuccessful or high-priority account.\n\n**IMPORTANT: Either `filter[companyId]` or `filter[companyName]` MUST be provided. Omitting both will result in a 422 error.**\n\nTo find Company Lookalikes, select the `companyId`, which identifies the company you want to use as the basis for finding lookalikes.\nIf you are not able to provide the `companyId`, you can provide only the `companyName` instead, the service\nwill attempt to resolve the best matching company and then return lookalike companies based on that company. The more precise the\ncompany name is (for example, use the full company name with correct spelling and full legal name), the more likely the\nservice is able to track down the company ID and use it to find lookalikes.\n\nOptionally, you can narrow the results using the following boolean filters. When set to true, each filter restricts\nlookalikes to companies that share the corresponding attribute with the reference company:\n- `filter[sameRevenueRange]`: same revenue range\n- `filter[sameCountry]`: same country\n- `filter[sameIndustry]`: same industry\n- `filter[sameEmployeeRange]`: same employee count range\n\nBehind the scenes, the model uses a semantic vector representation of the reference company's data to efficiently find similar companies in the ZoomInfo database.\n\nThe endpoint returns up to 100 lookalike companies, ordered from the most similar company to the least similar company (descending order by similarity score `attributes.score`).\nTo control the number of results returned, use the `page[size]` parameter with any integer value between 1 and 100.\nEach result includes the company name, similarity score, rank, and key firmographic attributes such as industry, revenue range, employee range, and country.","parameters":[{"name":"filter[companyId]","in":"query","required":false,"description":"Unique ZoomInfo identifier for the reference company used to retrieve lookalikes. Required if companyName is not provided.","schema":{"type":"string"},"explode":false},{"name":"filter[companyName]","in":"query","required":false,"description":"Name of the reference company used to retrieve lookalikes. Required if companyId is not provided.","schema":{"type":"string"},"explode":false},{"name":"filter[sameRevenueRange]","in":"query","required":false,"description":"When true, restricts results to companies within the same revenue range as the reference company.","schema":{"type":"boolean"},"explode":false},{"name":"filter[sameCountry]","in":"query","required":false,"description":"When true, restricts results to companies in the same country as the reference company.","schema":{"type":"boolean"},"explode":false},{"name":"filter[sameIndustry]","in":"query","required":false,"description":"When true, restricts results to companies in the same industry as the reference company.","schema":{"type":"boolean"},"explode":false},{"name":"filter[sameEmployeeRange]","in":"query","required":false,"description":"When true, restricts results to companies within the same employee count range as the reference company.","schema":{"type":"boolean"},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25, maximum is 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":25},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CompanyLookalikesResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Recommendations"],"security":[{"OAuth2Auth":["api:recommendations:read"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/copilot/v1/contacts/recommendations":{"get":{"operationId":"ContactRecommendationsInterface_getContactRecommendations","summary":"Get Contact Recommendations","description":"Contact Recommendations can be used to retrieve a ranked list of people at a target company who are most relevant for\na given sales motion (use case), such as prospecting, deal acceleration, or renewal and growth. The recommendations\nare derived from past user interactions and account activity, and are ranked by a machine learning model.\nThese recommendations can be used to build targeted call lists, prioritize outreach, or guide sellers toward the right\nstakeholders within an account.\n\nTo find Contact Recommendations select the appropriate `useCaseType` (for example, PROSPECTING or DEAL_ACCELERATION) and the\ntarget company (`filter[ziCompanyId]`). These inputs tell the model which sales motion you are running and which\naccount you want to focus on, so that it can surface the most relevant personas based on historical past user interactions or engagements.\n\nBehind the scenes, the model leverages data such as the user's past contact views, exports, and copies for the PROSPECTING motion, \nor contacts from a user's CRM related to closed won deals for the DEAL_ACCELERATION motion. \nThe model uses this data to infer which types of people are most likely to drive success for the selected motion. \nIt then finds similar contacts at the target company and scores them using a combination of similarity and propensity signals.\n\nThe endpoint returns up to 100 recommended contacts, ordered from most to least relevant. To control the number of recommendations returned, \nuse the `page[size]` parameter with any integer value between 1 and 100. Each recommendation contains additional metadata (`meta`)\nthat describes the reference person used to form the recommendation. Each recommendation includes the general similarity score (`score`), \na re-ranking score (`reRankingScore`) which uses several propensity signals (such as contact similarity, contact quality, title boosting, etc.)\nto refine relevancy. Returns `-1.0` when the ML reranking model did not run. Explainability metadata (`meta`) describes why this person was recommended (for example, the reference person\nand source of the interaction).","parameters":[{"name":"filter[useCaseType]","in":"query","required":true,"description":"Use case type for the recommendation. This filters recommendations based on the sales motion, such as prospecting, deal acceleration, or renewal and growth.","schema":{"$ref":"#/components/schemas/UseCaseType"},"explode":false},{"name":"filter[ziCompanyId]","in":"query","required":true,"description":"Unique identifier for a target company (ZoomInfo Company ID) in which to get contact recommendations.","schema":{"type":"integer","format":"int64"},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25, maximum is 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":25},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactRecommendationResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Recommendations"],"security":[{"OAuth2Auth":["api:recommendations:read"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/copilot/v1/contacts/lookalikes":{"get":{"operationId":"ContactLookalikesInterface_getContactLookalikes","summary":"Get Contact Lookalikes","description":"Contact Lookalikes can be used to retrieve a ranked list of people who are most similar to a given reference person. \nThe recommendations are generated by a machine learning model that compares the reference person's profile to other contacts. \nThe profile includes person characteristics such as title, seniority, department, as well as company characteristics such as industry and company size.\nThese lookalike contacts can be used to identify additional stakeholders, expand buyer networks, or build targeted prospecting lists based on known high-priority contacts.\n\nTo find Contact Lookalikes, select the `referencePersonId`, which identifies the person whose profile you want to use as the\nbasis for finding lookalikes. You can optionally provide a `targetCompanyId` to constrain the search to a specific\ncompany. If `targetCompanyId` is not provided, the model will search for similar contacts across all companies in the Zoominfo database.\n\nBehind the scenes, the model uses a semantic vector representation of the reference person's profile to efficiently find similar contact profiles in the ZoomInfo database. \nIt then applies a re-ranking algorithm to the set of similar contacts found, in order to boost relevance in the final return list. \n\nThe endpoint returns up to 100 lookalike contacts ordered from the most similar contact to the least similar contact (descending order by similarity score `attributes.score`). \nTo control the number of lookalikes returned, use the `page[size]` parameter with any integer value between 1 and 100. Each lookalike contact contains additional metadata (`meta`)\nthat describes the reference person used as the basis of the lookalike.","parameters":[{"name":"filter[targetCompanyId]","in":"query","required":false,"description":"Unique identifier (ZoomInfo Company ID) for the target company where lookalike contacts are searched. If not provided, the search is performed within the reference person's company.\n\nExample:\n* If Apple's Zoominfo Company ID is provided, the endpoint will search for contacts within Apple that have similar persona attributes to the provided `referencePersonId`.\n* If `targetCompanyId` **IS NOT** provided, the endpoint will search for contacts across all company that have similar persona attributes to the provided `referencePersonId`.","schema":{"type":"integer","format":"int64"},"explode":false},{"name":"filter[referencePersonId]","in":"query","required":true,"description":"Unique identifier for the reference person (ZoomInfo Person ID) that is used to search contact lookalikes. This is a required field.\n\nExample:\n* If a `referencePersonId` pointing to a person in Microsoft is provided, and if Apple's Zoominfo Company ID is provided as `targetCompanyId`, the endpoint will search for contacts within Apple that have similar persona attributes to this reference person from Microsoft.\n* Using the same example but if `targetCompanyId` **IS NOT** provided, the endpoint will search for contacts across all companies with similar persona attributes to the reference person from Microsoft.","schema":{"type":"integer","format":"int64"},"explode":false},{"name":"page[size]","in":"query","required":false,"description":"Number of records to return per page. Default is 25, maximum is 100.","schema":{"type":"integer","format":"int32","minimum":1,"maximum":100,"default":25},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ContactLookalikeResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Recommendations"],"security":[{"OAuth2Auth":["api:recommendations:read"]}],"x-api-roles":["fea:zia","fea:api"],"x-api-role-requirement":"ANY_REQUIRED"}},"/copilot/v1/customer-buyer-personas":{"get":{"operationId":"CustomerBuyerPersonaInterface_listCustomerBuyerPersonas","summary":"List Customer Buyer Personas","description":"Returns the list of Customer Buyer Personas configured for the authenticated customer.\n\nA Buyer Persona represents a profile of a key decision-maker or influencer that a company's sales and marketing teams target.\nPersonas capture attributes such as the buyer's role, objectives, priorities, and the motivations that influence purchasing decisions.\nPersonas help organizations align their go-to-market strategy by defining who the ideal buyers are, what problems they care about, and how they should be engaged.\nBuyer Personas can be connected to products or services with the people most likely to purchase them.\n\nIf you do not know the ID of the record you need, call\n[List Customer Buyer Personas](ref:customerbuyerpersonainterface_listcustomerbuyerpersonas) to browse the full set.\n\nCommon use cases\n- Retrieve all configured buyer personas\n- Discover persona IDs for use in other API operations\n- Load persona data for downstream integrations or automation","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerBuyerPersonaListResponse"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Customer Buyer Persona"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"post":{"operationId":"CustomerBuyerPersonaInterface_upsertCustomerBuyerPersona","summary":"Upsert Customer Buyer Persona","description":"Creates or updates a Customer Buyer Persona.\nThis endpoint performs an upsert operation:\nIf an `id` is included in the request body, the existing persona is updated. Only the fields provided in the request are modified (partial update).\n\nIf an `id` is not included, a new persona is created.\n\nWhen creating a new persona, `name` is the only required attribute. All other attributes are optional.\nA Buyer Persona represents a type of buyer that the customer's sales and marketing teams target. Each persona captures key details about the buyer's responsibilities, motivations,\nand priorities, helping teams tailor messaging and engagement strategies.\nBuyer Personas can be associated with specific products or services with relevant buyers.\n\nCommon use cases\n- Create new buyer personas for targeting and messaging\n- Update persona characteristics or engagement insights\n- Link personas to products or services for GTM alignment","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerBuyerPersonaModel"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"422":{"description":"Unprocessable Content","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Customer Buyer Persona"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerBuyerPersonaUpsert"}}},"description":"Buyer persona data to create, or fields to update. Include `id` to update an existing record; omit it to create a new one."},"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:gsa"]}},"/copilot/v1/customer-buyer-personas/{buyerPersonaId}":{"get":{"operationId":"CustomerBuyerPersonaInterface_getCustomerBuyerPersona","summary":"Get Customer Buyer Persona","description":"Retrieves a single Customer Buyer Persona by its unique identifier.\n\nA Buyer Persona represents a profile of a decision-maker or stakeholder that the customer's sales and marketing teams target.\nEach persona captures insights into who the ideal buyers are, what motivates them, and how to effectively engage them during the sales process.\nIf the specified buyerPersonaId does not exist, the endpoint returns **404 Not Found**.\n\nIf you do not know the ID of the record you need, call\n[List Customer Buyer Personas](ref:customerbuyerpersonainterface_listcustomerbuyerpersonas) to browse the full set.\n\nThis endpoint is typically used to retrieve the full configuration of a specific persona before updating or referencing it in downstream workflows.\n\nCommon use cases\n- Retrieve detailed information about a specific persona\n- Load persona data before updating the record\n- Use persona context in integrations or automation workflows","parameters":[{"name":"buyerPersonaId","in":"path","required":true,"description":"UUID of the buyer persona to retrieve.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerBuyerPersonaModel"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Customer Buyer Persona"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"delete":{"operationId":"CustomerBuyerPersonaInterface_deleteCustomerBuyerPersona","summary":"Delete Customer Buyer Persona","description":"Permanently deletes a Customer Buyer Persona identified by `buyerPersonaId`.\nDeleting a persona removes the associated buyer profile from the system and from any go-to-market configuration that references it.\nThis is a hard delete operation. Once deleted, the persona cannot be recovered.\nIf the specified buyerPersonaId does not exist, the endpoint returns **404 Not Found**.\nIf you want to hide a persona without permanently removing it, use the [Archive Customer Buyer Persona](ref:customerbuyerpersonainterface_archivecustomerbuyerpersona) endpoint instead.\n\nCommon use cases\n- Remove outdated or incorrect personas\n- Clean up duplicate persona records\n- Reset persona configuration before recreating it","parameters":[{"name":"buyerPersonaId","in":"path","required":true,"description":"UUID of the buyer persona to permanently delete.","schema":{"type":"string","format":"uuid"}}],"responses":{"204":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"nullable":true}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Customer Buyer Persona"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/customer-buyer-personas/{buyerPersonaId}/actions/archive":{"post":{"operationId":"CustomerBuyerPersonaInterface_archiveCustomerBuyerPersona","summary":"Archive Buyer Persona","description":"Archives a Customer Buyer Persona.\nArchiving hides the persona from standard list responses while retaining the record for historical reference, audit compliance, and potential restoration. \nArchived personas remain stored in the system and continue to count toward customer limits.\nWhen a persona is archived, the system sets the metadata fields `archivedAt` and `archivedBy`.\nThis action is reversible. The persona can be restored using the [Unarchive Customer Buyer Persona](ref:customerbuyerpersonainterface_unarchivecustomerbuyerpersona) endpoint.\n\nCommon use cases\n- Temporarily retire a persona that is no longer actively targeted\n- Maintain historical records without permanently deleting them\n- Clean up active persona lists while preserving data","parameters":[{"name":"buyerPersonaId","in":"path","required":true,"description":"UUID of the buyer persona to archive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerBuyerPersonaModel"}}}},"400":{"description":"Bad Request","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"401":{"description":"Unauthorized","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"403":{"description":"Forbidden","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"404":{"description":"Not Found","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}},"429":{"description":"Too Many Requests","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorResponseModel"}}}}},"tags":["Customer Buyer Persona"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["

# --- truncated at 32 KB (206 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/zoominfo/refs/heads/main/openapi/zoominfo-gtm-copilot-v1-openapi.json