{"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":["fea:gsa"]}},"/copilot/v1/customer-buyer-personas/{buyerPersonaId}/actions/unarchive":{"post":{"operationId":"CustomerBuyerPersonaInterface_unarchiveCustomerBuyerPersona","summary":"Unarchive Buyer Persona","description":"Restores a previously archived Customer Buyer Persona.\nUnarchiving makes the persona visible again in standard list responses and allows it to be used again in GTM configuration and workflows.\nWhen a persona is restored, the metadata fields `archivedAt` and `archivedBy` are cleared.\nIf the specified buyerPersonaId does not exist, the endpoint returns **404 Not Found**.\n\nCommon use cases\n- Reactivate a previously archived persona\n- Restore a persona that is relevant again for targeting or messaging\n- Re-enable personas used in go-to-market strategies","parameters":[{"name":"buyerPersonaId","in":"path","required":true,"description":"UUID of the buyer persona to unarchive.","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":["fea:gsa"]}},"/copilot/v1/customer-competitors":{"get":{"operationId":"CustomerCompetitorsInterface_listCustomerCompetitors","summary":"List Customer Competitors","description":"Returns the list of Customer Competitors configured for the authenticated customer.\n\nA Customer Competitor represents a company that competes with the customer's products or services in the market.\nCompetitor records capture structured competitive intelligence that helps sales and marketing teams understand the competitive landscape and position their products effectively.\nCompetitor profiles may include information such as competing products, win/loss analysis, displacement history, and reasons why deals are won or lost against a particular competitor.\nA competitor may optionally be linked to a ZoomInfo company record to enable additional enrichment and firmographic insights.\n\nIf you do not know the ID of the record you need, call\n[List Customer Competitors](ref:customercompetitorsinterface_listcustomercompetitors) to browse the full set.\n\nCommon use cases\n- Retrieve all competitors configured for competitive analysis\n- Discover competitor IDs for use in other API operations\n- Load competitor data for downstream integrations or automation","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorListResponse"}}}},"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 Competitors"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"post":{"operationId":"CustomerCompetitorsInterface_upsertCustomerCompetitor","summary":"Upsert Customer Competitor","description":"Creates or updates a Customer Competitor.\nThis endpoint performs an upsert operation:\nIf an `id` is included in the request body, the existing competitor record is updated. Only the attributes provided in the request are modified (partial update).\n\nIf an `id` is not included, a new competitor record is created.\n\nWhen creating a new competitor, `name` is the only required attribute. All other attributes are optional.\nCompetitor records store structured competitive intelligence including competing products, win/loss insights, displacement scenarios, and positioning details that help organizations understand how they perform against competitors in the market.\nCompetitors can also be associated with Products and Services to capture which products directly compete with one another.\n\nCommon use cases\n- Create competitor profiles for competitive intelligence\n- Update win/loss insights or competitive positioning\n- Link competitors to products or services in order to track product-level competition\n\nUse [List Customer Competitors](ref:customercompetitorsinterface_listcustomercompetitors)\nto find the `id` of a record you want to update or to check whether a competitor already exists.","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorModel"}}}},"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 Competitors"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorUpsert"}}},"description":"Customer competitor 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-competitors/{competitorId}":{"get":{"operationId":"CustomerCompetitorsInterface_getCustomerCompetitor","summary":"Get Customer Competitor by ID","description":"Retrieves a single Customer Competitor by its unique identifier.\n\nA Customer Competitor represents a company that competes with the customer's products or services.\nCompetitor records capture structured competitive intelligence such as competing products, win/loss analysis, displacement scenarios,\nand reasons why deals are won or lost against that competitor.\nA competitor may optionally be linked to a ZoomInfo company record for additional enrichment.\nIf the specified competitorId 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 Competitors](ref:customercompetitorsinterface_listcustomercompetitors)\nto browse the full set.\n\nCommon use cases\n- Retrieve detailed information about a specific competitor\n- Load competitor data before updating the record\n- Use competitor intelligence in integrations or automation workflows","parameters":[{"name":"competitorId","in":"path","required":true,"description":"UUID of the competitor to retrieve.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorModel"}}}},"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 Competitors"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"delete":{"operationId":"CustomerCompetitorsInterface_deleteCustomerCompetitor","summary":"Delete Customer Competitor","description":"Permanently deletes a Customer Competitor identified by `competitorId`.\nDeleting a competitor removes the associated competitive intelligence from the system.\nThis is a hard delete operation and cannot be undone.\nIf the specified `competitorId` does not exist, the endpoint returns **404 Not Found**.\n\nIf you want to hide a competitor without permanently removing it, use the [Archive Customer Competitor](ref:customercompetitorsinterface_archivecustomercompetitor) endpoint instead.\n\nCommon use cases\n- Remove outdated competitor profiles\n- Clean up duplicate competitor records\n- Reset competitor data before recreating it","parameters":[{"name":"competitorId","in":"path","required":true,"description":"UUID of the competitor 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 Competitors"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/customer-competitors/{competitorId}/actions/archive":{"post":{"operationId":"CustomerCompetitorsInterface_archiveCustomerCompetitor","summary":"Archive Customer Competitor","description":"Archives a Customer Competitor.\nArchiving hides the competitor from standard list responses while retaining the record for historical reference and audit purposes.\nArchived competitors remain stored in the system and continue to count toward customer limits.\nWhen a competitor is archived, the metadata fields `archivedAt` and `archivedBy` are set.\n\nThis action is reversible using the [Unarchive Customer Competitor](ref:customercompetitorsinterface_unarchivecustomercompetitor).\n\nCommon use cases\n- Temporarily remove inactive competitors\n- Preserve historical competitive intelligence\n- Simplify active competitor lists while retaining records","parameters":[{"name":"competitorId","in":"path","required":true,"description":"UUID of the competitor to archive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorModel"}}}},"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 Competitors"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/customer-competitors/{competitorId}/actions/unarchive":{"post":{"operationId":"CustomerCompetitorsInterface_unarchiveCustomerCompetitor","summary":"Unarchive Customer Competitor","description":"Restores a previously archived Customer Competitor.\nUnarchiving makes the competitor visible again in standard list responses and allows it to be used again in competitive intelligence workflows.\nWhen a competitor is restored, the metadata fields `archivedAt` and `archivedBy` are cleared.\nIf the specified `competitorId` does not exist, the endpoint returns **404 Not Found**.\n\nCommon use cases\n- Reactivate competitors that are relevant again\n- Restore archived competitive intelligence records\n- Re-enable competitors for GTM analysis","parameters":[{"name":"competitorId","in":"path","required":true,"description":"UUID of the competitor to unarchive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerCompetitorModel"}}}},"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 Competitors"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/ideal-company-profile":{"get":{"operationId":"CustomerIdealCompanySegmentInterface_listIdealCompanySegments","summary":"List Ideal Customer Profiles","description":"Returns a List of Ideal Customer Profile (ICPs) configured for the authenticated customer.\n\nAn Ideal Customer Profile represents a target company profile that aligns with a company's go-to-market strategy.\nEach segment defines the types of organizations most likely to benefit from the company's products or services.\nSegments typically describe target companies using firmographic attributes such as industry, company size, revenue range, geography, and other qualification criteria.\nThese segments help sales and marketing teams focus outreach on the companies most likely to convert.\n\nIdeal Customer Profile can be associated with products or services that are targeted toward the right types of companies.\n\nIf you do not know the ID of the record you need, call\n[List Ideal Customer Profiles](ref:customeridealcompanysegmentinterface_listidealcompanysegments) to browse the full set.\n\nCommon use cases\n- Retrieve all configured ICP segments\n- Discover segment IDs for use in other API operations\n- Sync ICP definitions with external GTM systems","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentListResponse"}}}},"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":["Ideal Customer Profile"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"post":{"operationId":"CustomerIdealCompanySegmentInterface_upsertIdealCompanySegment","summary":"Upsert Ideal Customer Profile","description":"Creates or updates an Ideal Customer Profile.\nThis endpoint performs an upsert operation:\nIf an `id` is included in the request body, the existing segment is updated. Only the attributes provided in the request are modified (partial update).\n\nIf an `id` is not included, a new segment is created.\n\nWhen creating a new segment, `name` is the only required attribute. All other attributes are optional.\nAn Ideal Customer Profile defines the type of companies that best match the organization’s target market.\nSegments typically describe firms using firmographic attributes such as industry, company size, revenue range, geography, and other qualification criteria.\n\nCommon use cases\n- Define new ICP segments for GTM targeting\n- Update firmographic filters used to identify target accounts\n- Align company targeting with products or services and personas","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentModel"}}}},"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":["Ideal Customer Profile"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentUpsert"}}},"description":"Ideal company segment 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/ideal-company-profile/{segmentId}":{"get":{"operationId":"CustomerIdealCompanySegmentInterface_getIdealCompanySegment","summary":"Get an Ideal Customer Profile","description":"Retrieves a single Ideal Customer Profile by its unique identifier.\n\nAn Ideal Customer Profile defines the profile of organizations that best match a company's target market.\nSegments typically describe companies using firmographic attributes such as industry, company size, revenue range, geography, and other qualification criteria.\nSegments may also include seed companies or structured search filters used for account matching.\nIf the specified segmentId 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 Ideal Customer Profiles](ref:customeridealcompanysegmentinterface_listidealcompanysegments) to browse the full set.\n\nCommon use cases\n- Retrieve the full configuration of a specific ICP segment\n- Load segment details before updating the record\n- Use ICP definitions in integrations or automation workflows","parameters":[{"name":"segmentId","in":"path","required":true,"description":"UUID of the Ideal Customer Profile to retrieve.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentModel"}}}},"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":["Ideal Customer Profile"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"delete":{"operationId":"CustomerIdealCompanySegmentInterface_deleteIdealCompanySegment","summary":"Delete Ideal Customer Profile","description":"Permanently deletes an Ideal Customer Profile identified by `segmentId`.\n\nDeleting a segment removes the associated target company profile from the system and from any go-to-market configuration that references it.\nThis is a hard delete operation and cannot be undone.\nIf the specified `segmentId` does not exist, the endpoint returns **404 Not Found**.\nIf you want to hide a segment without permanently removing it, use the [Archive Ideal Customer Profile](ref:customeridealcompanysegmentinterface_archiveidealcompanysegment) endpoint instead.\n\nUse [Get Ideal Customer Profile](ref:customeridealcompanysegmentinterface_getidealcompanysegment)\nto verify the profile exists before deletion.\n\nCommon use cases\n- Remove outdated or incorrect ICP definitions\n- Clean up duplicate segments\n- Reset segment configuration before recreating it","parameters":[{"name":"segmentId","in":"path","required":true,"description":"UUID of the Ideal Customer Profile 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":["Ideal Customer Profile"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/ideal-company-profile/{segmentId}/actions/archive":{"post":{"operationId":"CustomerIdealCompanySegmentInterface_archiveIdealCompanySegment","summary":"Archive ICP","description":"Archives an Ideal Customer Profile.\nArchiving hides the segment from standard list responses while retaining the record for historical reference, audit purposes, and possible restoration.\nArchived segments remain stored in the system and continue to count toward customer limits.\nWhen a segment is archived, the system sets the metadata fields `archivedAt` and `archivedBy`.\nThis action is reversible using the [Unarchive Ideal Customer Profile](ref:customeridealcompanysegmentinterface_unarchiveidealcompanysegment) endpoint.\n\nCommon use cases\n- Temporarily retire an ICP definition\n- Maintain historical GTM configuration for audit purposes\n- Simplify active targeting segments without losing data","parameters":[{"name":"segmentId","in":"path","required":true,"description":"UUID of the Ideal Customer Profile to archive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentModel"}}}},"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":["Ideal Customer Profile"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/ideal-company-profile/{segmentId}/actions/unarchive":{"post":{"operationId":"CustomerIdealCompanySegmentInterface_unarchiveIdealCompanySegment","summary":"Unarchive ICP","description":"Restores a previously archived Ideal Customer Profile.\nUnarchiving makes the segment visible again in standard list responses and allows it to be used again in GTM targeting and configuration workflows.\nWhen a segment is restored, the metadata fields `archivedAt` and `archivedBy` are cleared.\nIf the specified `segmentId` does not exist, the endpoint returns **404 Not Found**.\n\nCommon use cases\n- Reactivate previously archived ICP segments\n- Restore segments that are relevant again for targeting\n- Re-enable segments used in GTM configuration","parameters":[{"name":"segmentId","in":"path","required":true,"description":"UUID of the Ideal Customer Profile to unarchive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/IdealCompanySegmentModel"}}}},"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":["Ideal Customer Profile"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/customer-settings":{"get":{"operationId":"CustomerSettingsInterface_getCustomerSettings","summary":"Get Customer Settings","description":"Retrieves the customer settings for the authenticated customer.\n\nCustomer Settings represent the core company-level configuration.\nThis includes foundational information such as the company name, description, elevator pitch, and strategic go-to-market priorities.\nThis information provides the baseline context that AI agents use to generate recommendations, messaging, targeting insights,\nand account prioritization.\n\nThis resource is a singleton per customer, meaning each customer can have only one Customer Settings record.\nIf no configuration has been created yet, the endpoint will return **404 Not Found**.\n\nUse [Post Customer Settings](ref:customersettingsinterface_upsertcustomersettings) to create or update the settings.\n\nCommon use cases\n- Retrieve the current company context powering GTM AI features\n- Verify whether company configuration has been initialized\n- Load existing company overview information for editing or synchronization","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerSettingsModel"}}}},"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 Settings"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"post":{"operationId":"CustomerSettingsInterface_upsertCustomerSettings","summary":"Upsert Customer Settings","description":"Creates or updates the Customer Settings for the authenticated customer.\nCustomer Settings store the Company Overview configuration including the company name, description, elevator pitch,\nand strategic go-to-market priorities.\n\nThis endpoint performs an upsert operation:\nIf a Customer Settings record does not exist, it will be created.\nIf a record already exists, only the fields included in the request will be updated.\n\nEach customer can have only one Customer Settings record.\nAll attributes in the request body are optional, but at least one attribute must be provided. Requests with no attributes will\nreturn a **400 Bad Request**. Updates are applied as a partial update, meaning only the fields included in the request will be modified.\nAll other fields remain unchanged.\n\nCommon use cases\n- Initialize company configuration during setup\n- Update company overview information\n- Modify strategic priorities used by AI recommendations\n\nUse [Get Customer Settings](ref:customersettingsinterface_getcustomersettings) to retrieve the current settings\nbefore updating, or [Delete Customer Settings](ref:customersettingsinterface_deletecustomersettings) to remove them.","parameters":[],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerSettingsModel"}}}},"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 Settings"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/CustomerSettingsModelCreate"}}},"description":"Customer settings to create or fields to update."},"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:gsa"]},"delete":{"operationId":"CustomerSettingsInterface_deleteCustomerSettings","summary":"Delete Customer Settings","description":"Permanently deletes the Customer Settings record for the authenticated customer. Customer Settings store the customers\nCompany Overview configuration.\n\nDeleting this record removes that configuration from the system.\nThis resource is a singleton per customer, meaning each customer can have only one Customer Settings record.\nIf no Customer Settings record exists, the endpoint returns **404 Not Found**.\n\nThis is a hard delete operation. Once deleted, the record is removed from the backend and must be recreated using\n[Upsert Customer Settings](ref:customersettingsinterface_upsertcustomersettings) if needed.\n\nCommon use cases\n- Remove an existing company overview configuration\n- Reset customer-level company settings before recreating them\n- Clean up configuration that is no longer valid\n\nUse [Get Customer Settings](ref:customersettingsinterface_getcustomersettings) to verify settings exist before deletion,\nor [Upsert Customer Settings](ref:customersettingsinterface_upsertcustomersettings) to recreate them if needed.","parameters":[],"responses":{"204":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"nullable":true}}}},"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 Settings"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/products":{"get":{"operationId":"OrganizationOfferingsInterface_listOrganizationOfferings","summary":"List Products or Services","description":"Returns the complete list of Products or Services configured for the authenticated customer.\n\nAn Product or Service represents a product, service, or solution provided by your company and forms\nthe foundation of your go-to-market configuration. Products or Services capture key context such as the product's value proposition,\nthe pain points it addresses, proof points, target buyer personas, and ideal customer profiles.\n\nProducts or Services serve as the central linking object across GTM configuration, connecting Buyer Personas, Ideal Customer Profiles (ICPs),\nand Competitors to ensure alignment between targeting, messaging, and competitive positioning.\n\nIf you do not know the ID of the record you need, call\n[List Products or Services](ref:organizationofferingsinterface_listorganizationofferings) to browse the full set.\n\nUse this endpoint to browse all products or services or retrieve product or service IDs that can be used with other endpoints.\n\nCommon use cases\n- Retrieve all configured products or services\n- Discover offering IDs for use in other API operations\n- Load offering data for downstream GTM automation or AI workflows","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingListResponse"}}}},"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":["Products and Services"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"post":{"operationId":"OrganizationOfferingsInterface_upsertOrganizationOffering","summary":"Upsert Product or Service","description":"Creates or updates a Product or Service for the authenticated customer.\nA Product or Service represents a product, service, or solution provided by your company.\n\nProducts or Services form the foundation of your go-to-market configuration and capture key context such as the product's\nvalue proposition, the pain points it addresses, proof points, target buyer personas, and the ideal customer profiles it serves.\n\nThis endpoint performs an upsert operation:\nIf an `id` is included in the request body, the existing product or service is updated.\nOnly the attributes provided in the request are modified (partial update).\n\nIf an `id` is not provided, a new product or service is created.\n\nWhen creating a new product or service, name is the only required field. All other attributes are optional.\nA Product or Service acts as a central linking object across GTM configuration. Buyer Personas, Ideal Customer Profiles (ICPs),\nand Competitors can all be associated with a Product or Service to align targeting, messaging, and competitive positioning.\n\nCommon use cases\n- Create a new product or service\n- Update positioning, messaging, or targeting attributes for an existing product or service\n- Link products or services to buyer personas, ICPs, or competitors","parameters":[],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingModel"}}}},"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":["Products and Services"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingUpsert"}}},"description":"Product or service 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/products/{offeringId}":{"get":{"operationId":"OrganizationOfferingsInterface_getOrganizationOffering","summary":"Get Product or Service","description":"Retrieves a single product or service by ID. \n\nA product or service represents a discrete product or service provided by your company \nand forms the foundation of your go-to-market configuration. Each product or service record captures the \nstrategic context of a product: how it is positioned in the market, whom it targets, what pain points \nit addresses, and the value proposition it delivers. Returns **404 Not Found** if the product or service does not\nexist.\n\nIf you do not know the ID of the record you need, call\n[List Products or Services](ref:organizationofferingsinterface_listorganizationofferings) to browse the full set.\n\nThis endpoint is typically used when retrieving the full details of a specific product or service for viewing, editing,\nor integration with external systems.\n\nCommon use cases\n- Retrieve the full configuration of a specific product or service\n- Load product or service details before updating the record\n- Fetch product or service context for downstream workflows or integrations","parameters":[{"name":"offeringId","in":"path","required":true,"description":"UUID of the product or service to retrieve.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingModel"}}}},"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":["Products and Services"],"security":[{"OAuth2Auth":["api:gtm-config:read"]}],"x-api-roles":["fea:gsa"]},"delete":{"operationId":"OrganizationOfferingsInterface_deleteOrganizationOffering","summary":"Delete Product or Service","description":"Permanently deletes a Product or Service identified by `offeringId`.\n\nA Product or Service represents a product, service, or solution provided by your company and serves as a\ncore component of your go-to-market configuration. Deleting a Product or Service removes the associated strategic context\nused for positioning, targeting, and competitive analysis.\n\nThis is a hard delete operation. Once deleted, the Product or Service is permanently removed from the system and cannot be recovered.\nIf the specified offeringId does not exist, the endpoint returns **404 Not Found**.\nIf you want to hide a Product or Service without permanently removing it, use the [Archive Product or Service](ref:organizationofferingsinterface_archiveorganizationoffering) endpoint instead.\n\nUse [Get Product or Service](ref:organizationofferingsinterface_getorganizationoffering)\nto verify the Product or Service exists before deletion, or\n[Upsert Product or Service](ref:organizationofferingsinterface_upsertorganizationoffering)\nto recreate it afterward if needed.\n\nCommon use cases\n- Permanently remove an obsolete product or service\n- Clean up incorrect or duplicate product or service records\n- Reset a product or service before recreating it with updated configuration","parameters":[{"name":"offeringId","in":"path","required":true,"description":"UUID of the product or service 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":["Products and Services"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/products/{offeringId}/actions/archive":{"post":{"operationId":"OrganizationOfferingsInterface_archiveOrganizationOffering","summary":"Archive Product or Service","description":"Archives an Product or Service identified by `offeringId`.\n\nArchiving hides the product or service from standard list responses while retaining the record for historical reference, audit purposes,\nand potential restoration. The archived record remains stored in the system and continues to count toward customer limits.\nWhen a product or service is archived, the system sets the metadata fields `archivedAt` and `archivedBy`.\nThis operation is reversible. An archived product or service can be restored using the [Unarchive Product or Service](ref:organizationofferingsinterface_unarchiveorganizationoffering) endpoint.\n\nCommon use cases\n- Temporarily remove a product or service that is no longer actively sold\n- Hide deprecated products or services while retaining historical configuration\n- Maintain audit history without permanently deleting records","parameters":[{"name":"offeringId","in":"path","required":true,"description":"UUID of the product or service to archive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingModel"}}}},"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":["Products and Services"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}},"/copilot/v1/products/{offeringId}/actions/unarchive":{"post":{"operationId":"OrganizationOfferingsInterface_unarchiveOrganizationOffering","summary":"Unarchive Product or Service","description":"Restores a previously archived Product or Service.\n\nUnarchiving makes the product or service visible again in standard list responses and reactivates it for use across GTM configuration workflows.\nWhen a product or service is unarchived, the metadata fields `archivedAt` and `archivedBy` are cleared.\nIf the specified `offeringId` does not exist, the endpoint returns **404 Not Found**.\n\nCommon use cases\n- Restore a previously archived product or service\n- Reactivate products or services that have returned to market\n- Re-enable products or services used in GTM configuration","parameters":[{"name":"offeringId","in":"path","required":true,"description":"UUID of the product or service to unarchive.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/OrganizationOfferingModel"}}}},"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":["Products and Services"],"security":[{"OAuth2Auth":["api:gtm-config:manage"]}],"x-api-roles":["fea:gsa"]}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"AccountSummaryAttributes":{"type":"object","required":["markdown"],"properties":{"markdown":{"type":"string","description":"Markdown content providing a summary of account-related data."}},"description":"Attributes for the AccountSummary resource."},"AccountSummary":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"AccountSummary","pattern":"AccountSummary"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AccountSummaryAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a summary of account-related data."},"AccountSummaryResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AccountSummary"}],"description":"The primary data of the document"}},"description":"Resource model for an account summary response."},"ZoomInfo.Core.Foundations.ErrorSourceModel":{"type":"object","properties":{"cookie":{"type":"string","description":"Identifies the cookie name that caused the issue"},"header":{"type":"string","description":"Identifies the header name that caused the error"},"pointer":{"type":"string","description":"An RFC 6901 compliant JSON pointer to the entity in the request body that caused the error"},"parameter":{"type":"string","description":"The name of the path or query parameter that caused the error"}}},"ZoomInfo.Core.Foundations.ErrorModel":{"type":"object","required":["id","code","status"],"properties":{"id":{"type":"string","description":"The unique id used to identify this specific error instance"},"code":{"type":"string","description":"The error code describing the error category. A full list of error codes can be found in the documentation for each service"},"detail":{"type":"string","description":"Message containing the specific details about this occurrence of the error"},"source":{"allOf":[{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorSourceModel"}],"description":"An optional object identifying which part of the request caused the error"},"status":{"type":"string","description":"The HTTP status code for the error"},"title":{"type":"string","description":"The error name that describes this type of error"}},"description":"The object describing a specific error from the API"},"ZoomInfo.Core.Foundations.ErrorResponseModel":{"type":"object","required":["errors"],"properties":{"detail":{"type":"string","description":"A high-level detail of the error(s) that occurred during the request"},"title":{"type":"string","description":"A high-level summary of the error(s) detected"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/ZoomInfo.Core.Foundations.ErrorModel"},"description":"The list of errors raised during the request"}},"description":"The standard error response body model for the ZoomInfo API."},"AccountSummaryQuestionAttributes":{"type":"object","required":["answer"],"properties":{"answer":{"type":"string","description":"The answer to the account summary question."}},"description":"Attributes for the AccountSummaryQuestion resource."},"AccountSummaryQuestion":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"AccountSummaryQuestion","pattern":"AccountSummaryQuestion"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AccountSummaryQuestionAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a question and answer about account-related data."},"AccountSummaryQuestionResponse":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AccountSummaryQuestion"}],"description":"The primary data of the document"}},"description":"Response model for asking a question about account-related data."},"AccountSummaryQuestionRequestAttributes":{"type":"object","required":["question"],"properties":{"question":{"type":"string","description":"The question to ask about account-related data."}},"description":"Attributes for the AccountSummaryQuestionRequest resource."},"AccountSummaryQuestionRequestResource":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"AccountSummaryQuestionRequest","pattern":"AccountSummaryQuestionRequest"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AccountSummaryQuestionRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Represents a request to ask a question about account-related data."},"AccountSummaryQuestionRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AccountSummaryQuestionRequestResource"}],"description":"The primary data of the document"}},"description":"Request model for asking a question about account-related data."},"FundingSignalPayload":{"type":"object","required":["displayText","date","type","amount","investors"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"type":{"type":"string","description":"Type of funding round or event (e.g. 'Series A', 'Venture Round', 'Private Equity')."},"amount":{"type":"string","description":"Total capital raised in this funding event, expressed as a formatted string (e.g. '$10M')."},"investors":{"type":"array","items":{"type":"string"},"description":"List of investor names participating in the funding round."}},"description":"Funding signal payload - represents company funding events."},"FundingInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.funding","pattern":"zi.funding"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/FundingSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Funding insight model"},"CxoChangeSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"changeType":{"type":"string","description":"Specific type of change that triggered this signal."},"previousCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company ID of the person's previous employer."},"previousTitle":{"type":"string","description":"Person's previous job title."},"previousCompanyName":{"type":"string","description":"Name of the company where the person was previously employed."}},"description":"CXO change signal payload."},"CxoChangeInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.cxochange","pattern":"zi.cxochange"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/CxoChangeSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"CXO change insight model"},"ScoopsSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Scoops signal payload."},"ScoopsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.scoop","pattern":"zi.scoop"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/ScoopsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Scoops insight model"},"WebsightsSignalPayload":{"type":"object","required":["displayText","date","strength","url","signalId"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"strength":{"type":"string","description":"Computed intent strength label based on the pages visited. May be empty if intent level could not be determined."},"url":{"type":"string","description":"Domain of the customer's website that was visited (e.g. 'zoominfo.com'). This is the domain only, not a full URL with path."},"signalId":{"type":"string","description":"ZoomInfo-internal identifier that uniquely identifies this signal through the processing pipeline."}},"description":"Websights signal payload - represents web activity insights."},"WebsightsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.websights","pattern":"zi.websights"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/WebsightsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Websights insight model"},"BuyingCommitteeChangeSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"changeType":{"type":"string","description":"Specific type of change that triggered this signal."},"previousCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company ID of the person's previous employer."},"previousTitle":{"type":"string","description":"Person's previous job title."},"previousCompanyName":{"type":"string","description":"Name of the company where the person was previously employed."}},"description":"Buying committee change signal payload."},"BuyingCommitteeChangeInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.buyingcommitteechange","pattern":"zi.buyingcommitteechange"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/BuyingCommitteeChangeSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Buying committee change insight model"},"AliLocation":{"type":"object","required":["location","buyersCount"],"properties":{"location":{"type":"string","description":"Geographic location name."},"buyersCount":{"type":"integer","format":"int64","description":"Number of active buyers detected."}},"description":"Account Level Intent (ALI) location information."},"AccountLevelIntentSignalPayload":{"type":"object","required":["displayText","date","clusterName","score","scoreChange"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"clusterName":{"type":"string","description":"Name of the intent topic cluster that spiked. e.g. 'Sales Strategy'."},"score":{"type":"integer","format":"int64","description":"The account's current intent score after this signal. Values: 0 = NONE, 1 = LOW, 2 = MODERATE, 3 = HIGH. Always higher than the previous score as this represents a spike event."},"scoreChange":{"type":"string","description":"Description of how the intent score changed (e.g. from LOW to HIGH)."},"topics":{"type":"array","items":{"type":"string"},"description":"List of individual intent topic names within the cluster that contributed to the spike."},"topLocations":{"type":"array","items":{"$ref":"#/components/schemas/AliLocation"},"description":"Geographic breakdown of where the intent activity was detected, including location name and number of active buyers."}},"description":"Account level intent signal payload."},"AccountLevelIntentInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.account-level-intent.spike","pattern":"zi.account-level-intent.spike"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/AccountLevelIntentSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Account level intent insight model"},"CompetitorIntentSignal":{"type":"object","required":["displayText","date","ziCompanyId","name"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"name":{"type":"string","description":"Name of the competitor being researched."},"productsOrServices":{"type":"string","description":"Competitor's products or services that are being researched by the account."}},"description":"Competitor Intent Signal information."},"CompetitorIntentSignalPayload":{"type":"object","required":["displayText","date","competitor"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"competitor":{"allOf":[{"$ref":"#/components/schemas/CompetitorIntentSignal"}],"description":"Details about the competitor being researched, including the competitor's company ID, name, and relevant products or services."}},"description":"Competitor intent signal payload."},"CompetitorIntentInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.intent.competitor.spike","pattern":"zi.intent.competitor.spike"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/CompetitorIntentSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Competitor intent insight model"},"MpocChangeSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"changeType":{"type":"string","description":"Specific type of change that triggered this signal."},"previousCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company ID of the person's previous employer."},"previousTitle":{"type":"string","description":"Person's previous job title."},"previousCompanyName":{"type":"string","description":"Name of the company where the person was previously employed."}},"description":"MPOC change signal payload."},"MpocChangeInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.mpocchange","pattern":"zi.mpocchange"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/MpocChangeSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"MPOC change insight model"},"G2SignalPayload":{"type":"object","required":["displayText","date","type","subject"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"type":{"type":"string","description":"The type of G2 page visited. One of: 'Category', 'Compare', 'Competitors', 'Licensed Content', 'Pricing Page', 'Product Reference Page', 'Profile'."},"subject":{"type":"string","description":"Label combining type and content in the format '{type}: {content}' (e.g. 'Competitors: Acme Corp', 'Category: Sales Intelligence')."}},"description":"G2 signal payload."},"G2Insight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.g2","pattern":"zi.g2"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/G2SignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"G2 insight model"},"TrustRadiusActivityLabel":{"type":"string","enum":["Category","Product Listing","Product Details","Product Pricing","Product Reviews","Review","Comparison","Comparisons","Competitors","Features Scorecard","Product Paid CTA","Category Top Rated","Category Products","Product Overview"],"description":"Label indicating which type of TrustRadius page the activity occurred on.","x-enumDescriptions":{"CATEGORY":"Activity on a product category page.","PRODUCT_LISTING":"Activity on a product listing page.","PRODUCT_DETAILS":"Activity on a product details page.","PRODUCT_PRICING":"Activity on a product pricing page — strong buying intent signal.","PRODUCT_REVIEWS":"Activity on a product reviews page.","REVIEW":"Activity on an individual review.","COMPARISON":"Activity on a single product comparison page.","COMPARISONS":"Activity on a multi-product comparisons page.","COMPETITORS":"Activity on a competitors page for a product.","FEATURES_SCORECARD":"Activity on a features scorecard page comparing product capabilities.","PRODUCT_PAID_CTA":"Activity on a paid call-to-action on a product page.","CATEGORY_TOP_RATED":"Activity on a top-rated products list within a category.","CATEGORY_PRODUCTS":"Activity on the products listing within a category.","PRODUCT_OVERVIEW":"Activity on a product overview page."}},"TrustRadiusActivitySource":{"type":"string","enum":["Category","Competitor","Licensed Product"],"description":"Source indicating where the TrustRadius activity originated.","x-enumDescriptions":{"CATEGORY":"Activity originated from browsing a product category on TrustRadius.","COMPETITOR":"Activity originated from viewing a competitor's product page.","LICENSED_PRODUCT":"Activity originated from a product page that the tenant has licensed on TrustRadius."}},"TrustRadiusActivityType":{"type":"string","enum":["view","click","share"],"description":"Type of activity performed by a contact on TrustRadius.","x-enumDescriptions":{"VIEW":"The contact viewed a TrustRadius page.","CLICK":"The contact clicked on a TrustRadius page element.","SHARE":"The contact shared a TrustRadius page or review."}},"ActivityLocationInfo":{"type":"object","properties":{"locationCity":{"type":"string","description":"City of the location."},"locationState":{"type":"string","description":"State of the location."},"locationStateCode":{"type":"string","description":"State code of the location."},"locationCountry":{"type":"string","description":"Location country."},"locationCountryCode":{"type":"string","description":"Location country code."}},"description":"Activity location information for TrustRadius signals."},"TrustRadiusSignalPayload":{"type":"object","required":["displayText","date","activityLabel","activitySource","activityType","activityLocationInfo","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"activityLabel":{"allOf":[{"$ref":"#/components/schemas/TrustRadiusActivityLabel"}],"description":"Label of the TrustRadius Signal."},"activitySource":{"allOf":[{"$ref":"#/components/schemas/TrustRadiusActivitySource"}],"description":"Source of the TrustRadius Signal."},"activityType":{"allOf":[{"$ref":"#/components/schemas/TrustRadiusActivityType"}],"description":"Type of the TrustRadius Signal."},"activityLocationInfo":{"allOf":[{"$ref":"#/components/schemas/ActivityLocationInfo"}],"description":"Activity Location Info including city, state, country, etc."},"vendor":{"type":"string","description":"Vendor of the primary product or listing associated with this activity."},"name":{"type":"string","description":"The TrustRadius page type where the activity occurred (e.g. 'ProductListing', 'Comparison', 'Competitors')."},"type":{"type":"string","description":"Listing type of the primary product associated with this activity (e.g. 'product', 'service')."},"vendorB":{"type":"string","description":"If the activity includes a comparison between A and B, this field indicates the vendor of the comparison object B."},"nameB":{"type":"string","description":"If the activity includes a comparison between A and B, this field indicates the name of the comparison object B."},"typeB":{"type":"string","description":"If the activity includes a comparison between A and B, this field indicates the type of the comparison object B."},"text":{"type":"string","description":"Human-readable sentence describing the activity (e.g. 'Viewed the Acme Corp product listing'). Combines the activity type with the subject product name."}},"description":"TrustRadius signal payload."},"TrustRadiusInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.trustradius","pattern":"zi.trustradius"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/TrustRadiusSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"TrustRadius insight model"},"AnomalousHiringSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"Summary describing the unusual hiring activity, including context about the scale or nature of the hiring surge."},"department":{"type":"string","description":"Department where the unusual volume of hiring was detected (e.g. 'Engineering', 'Sales')."}},"description":"Anomalous hiring signal payload."},"AnomalousHiringInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.anomaloushiring","pattern":"zi.anomaloushiring"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/AnomalousHiringSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Anomalous hiring insight model"},"FormStatus":{"type":"string","enum":["SUBMITTED","PENDING"],"description":"Submission status of a completed form.","x-enumDescriptions":{"SUBMITTED":"The form was fully completed and submitted by the contact.","PENDING":"The form was started but not fully submitted (abandoned/partial)."}},"FormCompleteSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","formName","formStatus"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"formName":{"type":"string","description":"The customer-defined name of the submitted form, as configured in ZoomInfo FormComplete."},"formStatus":{"allOf":[{"$ref":"#/components/schemas/FormStatus"}],"description":"Status of the form."}},"description":"Form complete signal payload."},"FormCompleteInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.formcomplete","pattern":"zi.formcomplete"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/FormCompleteSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Form complete insight model"},"PodcastMentionsSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","text","ziContactId"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"text":{"type":"string","description":"AI-generated summary of the podcast episode in which the contact was featured as a guest."},"ziContactId":{"type":"integer","format":"int64","description":"The ZoomInfo contact ID for the person."},"externalUrl":{"type":"string","description":"URL to the podcast episode where the contact appeared."}},"description":"Podcast mentions signal payload."},"PodcastMentionsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.podcastmentions","pattern":"zi.podcastmentions"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PodcastMentionsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Podcast mentions insight model"},"MarketingCampaignsSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","description","campaignName","campaignAudienceCompanyName","clicks","impressions"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"description":{"type":"string","description":"Summary of the marketing campaign and its targeting criteria."},"campaignName":{"type":"string","description":"Name of the marketing campaign."},"campaignAudienceCompanyName":{"type":"string","description":"Name of the company targeted by the campaign."},"clicks":{"type":"integer","format":"int64","description":"Number of clicks the campaign received."},"impressions":{"type":"integer","format":"int64","description":"Number of impressions the campaign received."}},"description":"Marketing campaigns signal payload."},"MarketingCampaignsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.marketingcampaigns","pattern":"zi.marketingcampaigns"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/MarketingCampaignsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Marketing campaigns insight model"},"TechnologyStatus":{"type":"string","enum":["ADD","DROP"],"description":"Indicates whether a technology was added to the company's tech stack.","x-enumDescriptions":{"ADD":"The company has recently adopted this technology into their tech stack."}},"TechnologySignalPayload":{"type":"object","required":["displayText","date","category","subCategory","vendor","text","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"category":{"type":"string","description":"High-level technology category (e.g. 'CRM', 'Marketing Automation', 'Cloud Infrastructure')."},"subCategory":{"type":"string","description":"More specific classification within the category (e.g. 'Sales CRM', 'Email Marketing')."},"vendor":{"type":"string","description":"Name of the technology vendor or provider (e.g. 'Salesforce', 'HubSpot')."},"text":{"type":"string","description":"Description of the technology and its relevance to the signal (e.g. 'Salesforce is a cloud-based CRM platform used to manage sales pipelines and customer relationships')."},"changeType":{"allOf":[{"$ref":"#/components/schemas/TechnologyStatus"}],"description":"Status of the Technology signal."}},"description":"Technology signal payload."},"TechnologyInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.technology","pattern":"zi.technology"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/TechnologySignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Technology insight model"},"SeniorJobPostingsSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"department":{"type":"string","description":"Department associated with the open senior leadership role (e.g. 'Engineering', 'Finance')."},"text":{"type":"string","description":"Description of the open senior leadership role, including job title and any relevant details from the posting."}},"description":"Senior job postings signal payload."},"SeniorJobPostingsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.seniorjobpostings","pattern":"zi.seniorjobpostings"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/SeniorJobPostingsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Senior job postings insight model"},"PersonWebsightsIntentLevel":{"type":"string","enum":["High","Medium","Low","Unspecified"],"description":"Buying intent level inferred from a known contact's website visit behavior.","x-enumDescriptions":{"HIGH":"The contact has shown strong buying intent based on their website visit behavior.","MEDIUM":"The contact has shown moderate buying intent based on their website visit behavior.","LOW":"The contact has shown limited buying intent based on their website visit behavior.","UNSPECIFIED":"Intent level could not be determined for this contact's visit."}},"PersonWebsightsSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","url","intentLevel"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"url":{"type":"string","description":"URL of the page on your website that the contact visited."},"intentLevel":{"allOf":[{"$ref":"#/components/schemas/PersonWebsightsIntentLevel"}],"description":"Intent level of the signal."}},"description":"Person websights signal payload."},"PersonWebsightsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.personwebsights","pattern":"zi.personwebsights"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PersonWebsightsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Person websights insight model"},"PersonBasedNewsSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","description","source"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"description":{"type":"string","description":"Summary of the news article or story featuring this contact."},"source":{"type":"string","description":"Name of the publication or outlet that published the news (e.g. 'TechCrunch', 'Forbes')."}},"description":"Person based news signal payload."},"PersonBasedNewsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.personbasednews","pattern":"zi.personbasednews"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PersonBasedNewsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Person based news insight model"},"WonDealSignalPayload":{"type":"object","required":["displayText","date","signalId","companyName","opportunityName","type","closeDate","amount","opportunityOwner"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"signalId":{"type":"string","description":"Signal ID for the won deal signal."},"companyName":{"type":"string","description":"Name of the customer company the deal was closed with (e.g. 'Acme Corp')."},"opportunityName":{"type":"string","description":"Name of the CRM opportunity associated with the won deal."},"type":{"type":"string","description":"CRM opportunity type classifying the nature of the deal (e.g. 'New Business', 'Renewal', 'Upsell')."},"closeDate":{"type":"string","description":"Date the deal was closed, formatted as a string (e.g. '2024-01-15')."},"amount":{"type":"string","description":"Monetary value of the closed deal, expressed as a formatted string (e.g. '$50,000')."},"opportunityOwner":{"type":"string","description":"Name of the CRM user who owns the opportunity."}},"description":"Won deal signal payload."},"WonDealInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.wondeal","pattern":"zi.wondeal"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/WonDealSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Won deal insight model"},"NewContactPreviouslyWorkedForCustomerSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"changeType":{"type":"string","description":"Specific type of change that triggered this signal."},"previousCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company ID of the person's previous employer."},"previousTitle":{"type":"string","description":"Person's previous job title."},"previousCompanyName":{"type":"string","description":"Name of the company where the person was previously employed."}},"description":"New contact previously worked for customer signal payload."},"NewContactPreviouslyWorkedForCustomerInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.newcontactpreviouslyworkedforcustomer","pattern":"zi.newcontactpreviouslyworkedforcustomer"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/NewContactPreviouslyWorkedForCustomerSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"New contact previously worked for customer insight model"},"PersonChangeSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","changeType"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"changeType":{"type":"string","description":"Specific type of change that triggered this signal."},"previousCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company ID of the person's previous employer."},"previousTitle":{"type":"string","description":"Person's previous job title."},"previousCompanyName":{"type":"string","description":"Name of the company where the person was previously employed."}},"description":"Base model for person-related signal payloads with change tracking."},"PersonChangeInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.personchange","pattern":"zi.personchange"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PersonChangeSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Person change insight model"},"UpcomingMeetingSignalPayload":{"type":"object","required":["displayText","date","meetingSubject","meetingBrief","meetingStartTime","externalParticipants"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"meetingSubject":{"type":"string","description":"Subject line of the upcoming meeting as recorded in the calendar or CRM."},"meetingBrief":{"type":"string","description":"AI-generated summary providing context about the meeting, attendees, and key talking points."},"meetingStartTime":{"type":"string","description":"Scheduled start time of the meeting as an ISO 8601 string (e.g. '2024-06-15T14:00:00Z')."},"externalParticipants":{"type":"array","items":{"type":"string"},"description":"List of external meeting participants (those outside your organization). Each entry is the participant's full name (e.g. 'Jane Doe'), full name with job title (e.g. 'Jane Doe, VP of Marketing'), or email address if no name is available (e.g. 'alex@example.com')."}},"description":"Upcoming meeting signal payload."},"UpcomingMeetingInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.upcomingmeeting","pattern":"zi.upcomingmeeting"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/UpcomingMeetingSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Upcoming meeting insight model"},"LowActiveContactsSignalPayload":{"type":"object","required":["displayText","date","engagedContactsCount","lastEngagementDate"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"engagedContactsCount":{"type":"integer","format":"int64","description":"Number of contacts at this account who have been engaged (via CRM or Chorus activity) on the open opportunity."},"lastEngagementDate":{"type":"string","format":"date-time","description":"UTC timestamp of the most recent engagement activity detected on the open opportunity."}},"description":"Low active contacts signal payload."},"LowActiveContactsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.lowactivecontacts","pattern":"zi.lowactivecontacts"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/LowActiveContactsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Low active contacts insight model"},"NoDecisionMakerSignalPayload":{"type":"object","required":["displayText","date","engagedContactsCount","lastEngagementDate"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"engagedContactsCount":{"type":"integer","format":"int64","description":"Number of contacts at this account who have been engaged (via CRM or Chorus activity) on the open opportunity."},"lastEngagementDate":{"type":"string","format":"date-time","description":"UTC timestamp of the most recent engagement activity detected on the open opportunity."}},"description":"No decision maker signal payload."},"NoDecisionMakerInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.nodecisionmaker","pattern":"zi.nodecisionmaker"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/NoDecisionMakerSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"No decision maker insight model"},"NoPostMeetingFollowUpSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name","subject","numberOfParticipants"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."},"subject":{"type":"string","description":"Subject line of the meeting that occurred without a follow-up email."},"meetingSource":{"type":"string","description":"System or integration that recorded the meeting (e.g. 'Chorus', 'Salesforce')."},"numberOfParticipants":{"type":"integer","format":"int64","description":"Number of meeting participants."}},"description":"No post meeting follow up signal payload."},"NoPostMeetingFollowUpInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.nopostmeetingfollowup","pattern":"zi.nopostmeetingfollowup"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/NoPostMeetingFollowUpSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"No post meeting follow up insight model"},"UpcomingRenewalSignalPayload":{"type":"object","required":["displayText","date","renewalDate","signalId"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"renewalDate":{"type":"string","format":"date-time","description":"UTC timestamp of when the renewal is due."},"signalId":{"type":"string","description":"Unique identifier for this upcoming renewal signal instance."}},"description":"Upcoming renewal signal payload."},"UpcomingRenewalInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.upcomingrenewal","pattern":"zi.upcomingrenewal"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/UpcomingRenewalSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Upcoming renewal insight model"},"MASignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"M&A signal payload."},"MAInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.m&a","pattern":"zi.m&a"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/MASignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"M&A insight model"},"ProductLaunchSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Product launch signal payload."},"ProductLaunchInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.productlaunch","pattern":"zi.productlaunch"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/ProductLaunchSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Product launch insight model"},"EarningsSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Earnings signal payload."},"EarningsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.earnings","pattern":"zi.earnings"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/EarningsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Earnings insight model"},"PartnershipSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Partnership signal payload."},"PartnershipInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.partnership","pattern":"zi.partnership"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PartnershipSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Partnership insight model"},"LayoffsSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Layoffs signal payload."},"LayoffsInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.layoffs","pattern":"zi.layoffs"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/LayoffsSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Layoffs insight model"},"PainPointSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Pain point signal payload."},"PainPointInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.painpoint","pattern":"zi.painpoint"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/PainPointSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Pain point insight model"},"DivestitureSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Divestiture signal payload."},"DivestitureInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.divestiture","pattern":"zi.divestiture"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/DivestitureSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Divestiture insight model"},"IPOSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"IPO signal payload."},"IPOInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.ipo","pattern":"zi.ipo"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/IPOSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"IPO insight model"},"AwardSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Award signal payload."},"AwardInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.award","pattern":"zi.award"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/AwardSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Award insight model"},"ProjectSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Project signal payload."},"ProjectInsight":{"type":"object","required":["ziCompanyId","signalId","signalType","signalPayload"],"properties":{"id":{"type":"integer","format":"int64","description":"Unique id for the insight."},"ziCompanyId":{"type":"integer","format":"int64","description":"Company id."},"signalId":{"type":"string","description":"Signal id."},"signalType":{"type":"string","description":"Type of the signal.","default":"zi.project","pattern":"zi.project"},"signalPayload":{"allOf":[{"$ref":"#/components/schemas/ProjectSignalPayload"}],"description":"Structured payload containing signal-specific data based on the signal type."},"insightDate":{"type":"string","format":"date-time","description":"Date of the insight."},"expiresAt":{"type":"string","format":"date-time","description":"Expiration date of the insight."},"createdAt":{"type":"string","format":"date-time","description":"Date of creation of the insight."}},"description":"Project insight model"},"InsightUnion":{"type":"object","oneOf":[{"$ref":"#/components/schemas/FundingInsight"},{"$ref":"#/components/schemas/CxoChangeInsight"},{"$ref":"#/components/schemas/ScoopsInsight"},{"$ref":"#/components/schemas/WebsightsInsight"},{"$ref":"#/components/schemas/BuyingCommitteeChangeInsight"},{"$ref":"#/components/schemas/AccountLevelIntentInsight"},{"$ref":"#/components/schemas/CompetitorIntentInsight"},{"$ref":"#/components/schemas/MpocChangeInsight"},{"$ref":"#/components/schemas/G2Insight"},{"$ref":"#/components/schemas/TrustRadiusInsight"},{"$ref":"#/components/schemas/AnomalousHiringInsight"},{"$ref":"#/components/schemas/FormCompleteInsight"},{"$ref":"#/components/schemas/PodcastMentionsInsight"},{"$ref":"#/components/schemas/MarketingCampaignsInsight"},{"$ref":"#/components/schemas/TechnologyInsight"},{"$ref":"#/components/schemas/SeniorJobPostingsInsight"},{"$ref":"#/components/schemas/PersonWebsightsInsight"},{"$ref":"#/components/schemas/PersonBasedNewsInsight"},{"$ref":"#/components/schemas/WonDealInsight"},{"$ref":"#/components/schemas/NewContactPreviouslyWorkedForCustomerInsight"},{"$ref":"#/components/schemas/PersonChangeInsight"},{"$ref":"#/components/schemas/UpcomingMeetingInsight"},{"$ref":"#/components/schemas/LowActiveContactsInsight"},{"$ref":"#/components/schemas/NoDecisionMakerInsight"},{"$ref":"#/components/schemas/NoPostMeetingFollowUpInsight"},{"$ref":"#/components/schemas/UpcomingRenewalInsight"},{"$ref":"#/components/schemas/MAInsight"},{"$ref":"#/components/schemas/ProductLaunchInsight"},{"$ref":"#/components/schemas/EarningsInsight"},{"$ref":"#/components/schemas/PartnershipInsight"},{"$ref":"#/components/schemas/LayoffsInsight"},{"$ref":"#/components/schemas/PainPointInsight"},{"$ref":"#/components/schemas/DivestitureInsight"},{"$ref":"#/components/schemas/IPOInsight"},{"$ref":"#/components/schemas/AwardInsight"},{"$ref":"#/components/schemas/ProjectInsight"}],"discriminator":{"propertyName":"signalType","mapping":{"zi.funding":"#/components/schemas/FundingInsight","zi.cxochange":"#/components/schemas/CxoChangeInsight","zi.scoop":"#/components/schemas/ScoopsInsight","zi.websights":"#/components/schemas/WebsightsInsight","zi.buyingcommitteechange":"#/components/schemas/BuyingCommitteeChangeInsight","zi.account-level-intent.spike":"#/components/schemas/AccountLevelIntentInsight","zi.intent.competitor.spike":"#/components/schemas/CompetitorIntentInsight","zi.mpocchange":"#/components/schemas/MpocChangeInsight","zi.g2":"#/components/schemas/G2Insight","zi.trustradius":"#/components/schemas/TrustRadiusInsight","zi.anomaloushiring":"#/components/schemas/AnomalousHiringInsight","zi.formcomplete":"#/components/schemas/FormCompleteInsight","zi.podcastmentions":"#/components/schemas/PodcastMentionsInsight","zi.marketingcampaigns":"#/components/schemas/MarketingCampaignsInsight","zi.technology":"#/components/schemas/TechnologyInsight","zi.seniorjobpostings":"#/components/schemas/SeniorJobPostingsInsight","zi.personwebsights":"#/components/schemas/PersonWebsightsInsight","zi.personbasednews":"#/components/schemas/PersonBasedNewsInsight","zi.wondeal":"#/components/schemas/WonDealInsight","zi.newcontactpreviouslyworkedforcustomer":"#/components/schemas/NewContactPreviouslyWorkedForCustomerInsight","zi.personchange":"#/components/schemas/PersonChangeInsight","zi.upcomingmeeting":"#/components/schemas/UpcomingMeetingInsight","zi.lowactivecontacts":"#/components/schemas/LowActiveContactsInsight","zi.nodecisionmaker":"#/components/schemas/NoDecisionMakerInsight","zi.nopostmeetingfollowup":"#/components/schemas/NoPostMeetingFollowUpInsight","zi.upcomingrenewal":"#/components/schemas/UpcomingRenewalInsight","zi.m&a":"#/components/schemas/MAInsight","zi.productlaunch":"#/components/schemas/ProductLaunchInsight","zi.earnings":"#/components/schemas/EarningsInsight","zi.partnership":"#/components/schemas/PartnershipInsight","zi.layoffs":"#/components/schemas/LayoffsInsight","zi.painpoint":"#/components/schemas/PainPointInsight","zi.divestiture":"#/components/schemas/DivestitureInsight","zi.ipo":"#/components/schemas/IPOInsight","zi.award":"#/components/schemas/AwardInsight","zi.project":"#/components/schemas/ProjectInsight"}}},"CompanyInsight":{"type":"object","required":["insights"],"properties":{"insights":{"type":"array","items":{"$ref":"#/components/schemas/InsightUnion"},"description":"Array of insights for this company."}},"description":"Attributes for company insight."},"CompanyInsightsByTypeResponseResource":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyInsights","pattern":"CompanyInsights"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanyInsight"}],"description":"The attributes defining the resource"}},"description":"Company insights by type response resource."},"CompanyInsightsByTypeResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyInsightsByTypeResponseResource"},"description":"The primary data of the document"}},"description":"Response model for retrieving company insights by type."},"SignalType":{"type":"string","enum":["zi.funding","zi.cxochange","zi.scoop","zi.websights","zi.buyingcommitteechange","zi.account-level-intent.spike","zi.intent.competitor.spike","zi.mpocchange","zi.g2","zi.trustradius","zi.anomaloushiring","zi.formcomplete","zi.podcastmentions","zi.marketingcampaigns","zi.technology","zi.seniorjobpostings","zi.personwebsights","zi.personbasednews","zi.wondeal","zi.newcontactpreviouslyworkedforcustomer","zi.personchange","zi.upcomingmeeting","zi.lowactivecontacts","zi.nodecisionmaker","zi.nopostmeetingfollowup","zi.upcomingrenewal","zi.m&a","zi.productlaunch","zi.earnings","zi.partnership","zi.layoffs","zi.painpoint","zi.divestiture","zi.ipo","zi.award","zi.project"],"description":"Type of sales intelligence signal for a company insight.","x-enumDescriptions":{"FUNDING":"Major funding rounds indicating growth or investment momentum. Signal lasts 90 days. No setup requirements.","CXO_CHANGE":"Promotions, new hires, and departures where contacts must have a C-level job title. Signal lasts 30 days. No setup requirements.","SCOOPS":"Proprietary ZoomInfo intelligence gathered from research, indicating a company has a known initiative, pain point, or project that creates a sales opportunity.","WEBSIGHT":"Unusual spike in website visits indicating heightened account activity. Defined as 0.75 standard deviation above the mean over a rolling 7 day period with at least 5 unique visits and an average session duration longer than 5 seconds on high or medium ranked pages. Requires Websights setup.","BUYING_COMMITTEE_CHANGE":"Promotions, new hires, and departures where contacts must match the criteria of a user's default buying group. Signal lasts 30 days. No setup requirements.","ACCOUNT_LEVEL_INTENT":"Increase in Account Level Intent score in either the past day (for AI Enterprise package) or past week (for AI Advanced package) vs prior baseline level. Requires topics or topic clusters to be assigned.","COMPETITOR_INTENT":"Account is meaningfully researching a competitor or competitive topic (an intent topic that is mapped as a competitive product or company to the user's company). Requires topics or topic clusters to be assigned.","MPOC_CHANGE":"Promotions, new hires, and departures. Signal lasts 30 days. Requires CRM integration.","G2":"Visits to G2 competitor or company product pages. Signal lasts 90 days. Requires an active G2 subscription and integration.","TRUST_RADIUS":"Visits to competitor or product pages on TrustRadius revealing competitive or interest intent. Signal lasts 90 days. Requires an active TrustRadius subscription and integration.","ANOMALOUS_HIRING":"Publicly announced hiring plans indicating team expansion or organizational growth. Restricted to hiring plans describing greater than normal hiring in departments in the user's default buying group. Signal lasts 30 days. No setup requirements.","FORM_COMPLETE":"Form submissions or abandonments detected via ZoomInfo FormComplete. Contact matches the criteria of the user's default buying group or the company has an open opportunity. Signal lasts 14 days. Requires ZoomInfo FormComplete setup.","PODCAST_MENTIONS":"Contact features as a guest on a recent podcast episode. Contact must be in user's default buying group. Signal lasts 30 days. No setup requirements.","MARKETING_CAMPAIGNS":"Account actively engaged by a ZoomInfo Marketing campaign. Requires ZoomInfo Marketing to be used for the campaign.","TECHNOLOGY":"Technology is related to one of your technologies, helping you tailor your pitch and gauge the potential fit for your solution. Signal lasts 30 days. No setup requirements.","SENIOR_JOB_POSTINGS":"Open senior leadership roles (C-level, VP, or Head) indicating organizational change. Signal lasts 30 days. No setup requirements.","PERSON_WEBSIGHTS":"Identifies key contacts visiting your website, revealing engagement and potential buying intent. Contact must be in user's default buying group. Signal lasts 30 days. Requires Enterprise package and Websights setup.","PERSON_BASED_NEWS":"News about key contacts enabling personalized outreach and timely re-engagement. Contact must be in user's default buying group. Signal lasts 30 days. No setup requirements.","WON_DEAL":"Someone at your company recently won a deal that is similar to one of your accounts. Similarity based on Similar Companies data with emphasis on industry. Requires CRM to be connected.","NEW_CONTACT_PREVIOUSLY_WORKED_FOR_CUSTOMER":"Promotions, new hires, and departures. Signal lasts 30 days. Requires CRM integration.","PERSON_CHANGE":"Promotions, new hires, and departures where contacts must have received prior communication. Signal lasts 30 days. No setup requirements.","UPCOMING_MEETING":"Alerts for upcoming meetings with attendee context and AI-generated summaries. Requires CRM (Salesforce, HubSpot, or Microsoft Dynamics) and Chorus (user-level) to be connected.","LOW_ACTIVE_CONTACTS":"Open opportunity with engagement limited to one contact after 30 days. Monitors CRM and Chorus activity types. Requires CRM (Salesforce, HubSpot, or Microsoft Dynamics) and Chorus (user-level) to be connected.","NO_DECISION_MAKER":"Opportunity open for 30 days without engagement from a director-level or higher contact. Monitors CRM and Chorus activity types. Requires CRM (Salesforce, HubSpot, or Microsoft Dynamics) and Chorus (user-level) to be connected.","NO_POSTMEETING_FOLLOWUP":"A meeting has taken place but no email has been sent within 24 hours. Requires CRM (Salesforce, HubSpot, or Microsoft Dynamics) and Chorus (user-level) to be connected.","UPCOMING_RENEWAL":"Renewal due within 90 days but no recent engagement detected. Triggered by Chorus engagement (email, meeting) and CRM (opportunity, tasks, events) with no activity. Requires CRM (Salesforce, HubSpot, or Microsoft Dynamics) and Chorus (user-level) to be connected.","MA":"Mergers, acquisitions, or other consolidations of companies or assets. Signal lasts 30 days. No setup requirements.","PRODUCT_LAUNCH":"Announcement of new products, services, or features. Filtered to scoop topics aligned to your account's value proposition. Signal lasts 30 days. No setup requirements.","EARNINGS":"Summaries of public company earnings calls revealing strategic direction and performance signals. Signal lasts 30 days. Requires Enterprise package.","PARTNERSHIP":"Service agreements, outsourcing agreements, agreement mediations, contract extensions and other collaborative efforts. Filtered to scoop topics aligned to your account's value proposition. Signal lasts 30 days. No setup requirements.","LAYOFFS":"Publicly announced layoffs suggesting organizational change or contraction. Signal lasts 30 days. No setup requirements.","PAINPOINT":"Challenges identified that may impact business operations or performance. Filtered to scoop topics aligned to your account's value proposition. Signal lasts 30 days. No setup requirements.","DIVESTITURE":"Company announces the sale or spin-off of a division or asset. Signal lasts 30 days. No setup requirements.","IPO":"Initial public offering or a stock market launch. Signal lasts 30 days. No setup requirements.","AWARD":"Recognition of a company, product, or employee in formal awards or industry rankings (e.g., 'Best of', 'Top Company'). Aligned to topics related to your account's value proposition. Signal lasts 30 days. No setup requirements.","PROJECT":"Department-specific initiatives being planned, underway, or recently completed. Filtered to scoop topics aligned to your account's value proposition. Signal lasts 30 days. No setup requirements."}},"CompanyInsightsByTypeRequestAttributes":{"type":"object","required":["ziCompanyIds"],"properties":{"ziCompanyIds":{"type":"array","items":{"type":"integer","format":"int64"},"maxItems":50,"description":"List of ZoomInfo company IDs to retrieve insights for (maximum 50 companies per request)."},"signalTypes":{"type":"array","items":{"$ref":"#/components/schemas/SignalType"},"description":"Optional filter for specific insight types. If not provided or empty, returns insights of all available types."}},"description":"Request attributes for retrieving company insights filtered by signal type."},"CompanyInsightsSearch":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"CompanyInsightsSearch","pattern":"CompanyInsightsSearch"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CompanyInsightsByTypeRequestAttributes"}],"description":"The attributes defining the resource"}},"description":"Company insights by type request resource."},"CompanyInsightsByTypeRequest":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CompanyInsightsSearch"}],"description":"The primary data of the document"}},"description":"Request model for retrieving company insights by type."},"SimilarCompanyAttributes":{"type":"object","required":["companyName","score","rank","industry","revenueRange","employeeRange","country"],"properties":{"companyName":{"type":"string","description":"Name of the lookalike company."},"score":{"type":"number","format":"double","description":"Similarity score between the input company and the lookalike company, ranging from 0 to 1. Higher values indicate higher similarity."},"rank":{"type":"integer","format":"int32","description":"Rank of the lookalike company in the results, with 1 being the most similar."},"industry":{"type":"string","description":"Primary industry of the lookalike company."},"revenueRange":{"type":"string","description":"Revenue range of the lookalike company."},"employeeRange":{"type":"string","description":"Employee count range of the lookalike company."},"country":{"type":"string","description":"Country where the lookalike company is headquartered."}},"description":"Attributes describing a single similar company."},"CompanyLookalike":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CompanyLookalike","pattern":"CompanyLookalike"},"attributes":{"allOf":[{"$ref":"#/components/schemas/SimilarCompanyAttributes"}],"description":"The attributes defining the resource"}},"description":"Resource model for a company lookalike result."},"CompanyLookalikesResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CompanyLookalike"},"description":"The primary data of the document"}},"description":"Response model for company lookalikes"},"UseCaseType":{"type":"string","enum":["PROSPECTING","DEAL_ACCELERATION","RENEWAL_AND_GROWTH"],"description":"Type of use case for contact recommendations.","x-enumDescriptions":{"PROSPECTING":"Prospecting. Used when a sales person is looking to reach out to contacts to establish a connection with a new account/company to pitch their company's product.","DEAL_ACCELERATION":"Deal acceleration. Used when a sales person has already established a connection and pitched their product with a potential buyer account/company, found potential product fit, and is in the process of confirming interest and negotiating a deal.","RENEWAL_AND_GROWTH":"Renewal and growth. Used when a sales person is interacting with an existing customer to renew a deal or expand the account (for example, more seats or an upgraded pricing model)."}},"ContactRecommendationAttributes":{"type":"object","required":["rank","score","reRankingScore"],"properties":{"rank":{"type":"integer","format":"int32","description":"Rank of the recommended contact (1-based, lower is better). Contacts are ordered from most to least relevant."},"score":{"type":"number","format":"double","description":"Similarity score between the reference person and the recommended contact. Higher values indicate greater similarity. Due to the nature of vector store similarity calculations, values may occasionally exceed 1.0."},"reRankingScore":{"type":"number","format":"double","description":"Re-ranking score of the recommended contact, produced by a machine learning model applied after initial retrieval to refine relevancy using propensity signals (contact similarity, quality, title boosting, etc.). Higher values indicate greater relevancy. Returns -1.0 when the ML reranking model did not run."},"recommendedPersonBrief":{"type":"string","description":"Brief description of the recommended contact's profile, used to explain why this person was recommended. Absent when profile data is unavailable."}},"description":"Attributes for a contact recommendation entity."},"SourceType":{"type":"string","enum":["AMPLITUDE_COPIED_CONTACTS","AMPLITUDE_EXPORTED_CONTACTS","AMPLITUDE_VIEWED_CONTACTS","CRM_CLOSED_WON_ENGAGED_CONTACTS","CRM_CLOSED_WON_CONTACTS","COLD_START_CONTACTS"],"description":"Source interaction type used to generate contact recommendations.","x-enumDescriptions":{"AMPLITUDE_COPIED_CONTACTS":"Contacts copied from ZoomInfo during prospecting.","AMPLITUDE_EXPORTED_CONTACTS":"Contacts exported from ZoomInfo in bulk.","AMPLITUDE_VIEWED_CONTACTS":"Contacts viewed via contact card/profile in ZoomInfo.","CRM_CLOSED_WON_ENGAGED_CONTACTS":"Contacts that were engaged with in closed-won deals in the user's CRM.","CRM_CLOSED_WON_CONTACTS":"Contacts recorded as connected to successful (closed-won) deals in the user's CRM.","COLD_START_CONTACTS":"Contacts of interest for new users or cold-start scenarios where there is limited interaction history."}},"ExplainabilityMetadata":{"type":"object","properties":{"sourceType":{"allOf":[{"$ref":"#/components/schemas/SourceType"}],"description":"Source interaction type used to generate this recommendation, such as copied, exported, viewed, or CRM closed-won contacts."},"referencePersonId":{"type":"integer","format":"int64","description":"Unique identifier for a reference person (ZoomInfo Person ID). A reference person is someone the salesperson has interacted with through the ZoomInfo platform (e.g. copy, export, view) or a contact found in the tenant's CRM from past closed-won deals."},"referencePersonBrief":{"type":"string","description":"Brief description of the reference person's profile that was used to generate this recommendation."}},"description":"Explainability metadata for a contact recommendation."},"ContactRecommendation":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactRecommendation","pattern":"ContactRecommendation"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactRecommendationAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/ExplainabilityMetadata"}],"description":"Non-standard meta information about the resource"}},"description":"Contact recommendation resource."},"ContactRecommendationResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactRecommendation"},"description":"The primary data of the document"}},"description":"Response model for contact recommendations."},"ContactLookalikeAttributes":{"type":"object","required":["rank","score","lookalikePersonBrief"],"properties":{"rank":{"type":"integer","format":"int32","description":"Rank of the lookalike contact, with 1 being the most similar to the reference person."},"score":{"type":"number","format":"double","description":"Similarity score between the reference person and the lookalike contact, ranging from 0 to 1. Higher values indicate higher similarity."},"lookalikePersonBrief":{"type":"string","description":"Brief description of the lookalike contact."}},"description":"Attributes for a contact lookalike entity."},"LookalikeMetadata":{"type":"object","required":["referencePersonId","referencePersonBrief"],"properties":{"referencePersonId":{"type":"integer","format":"int64","description":"Unique identifier for the reference person (ZoomInfo Person ID) that is used to search contact lookalikes."},"referencePersonBrief":{"type":"string","description":"Brief description of the reference person used to find lookalike contacts."}},"description":"Metadata for a lookalike contact entity."},"ContactLookalike":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"ContactLookalike","pattern":"ContactLookalike"},"attributes":{"allOf":[{"$ref":"#/components/schemas/ContactLookalikeAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/LookalikeMetadata"}],"description":"Non-standard meta information about the resource"}},"description":"Contact lookalikes resource"},"ContactLookalikeResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ContactLookalike"},"description":"The primary data of the document"}},"description":"Response model for contact lookalikes."},"GtmConfigSourceType":{"type":"string","enum":["manual","import","system","mcp"],"description":"Source type indicating how a GTM configuration record was created or last modified.\nUsed across all customer-level entities for audit provenance tracking.\nWhen source is explicitly set in a request, the corresponding created_by/updated_by must also be provided.\nDefaults to 'manual' when not specified.","x-enumDescriptions":{"MANUAL":"Created or updated manually by a user through the GTM Studio UI.","IMPORT":"Imported from an external data source such as CRM or CSV upload.","SYSTEM":"Generated automatically by the platform (e.g., system enrichment or background jobs).","MCP":"Created or updated via the GTM Config MCP integration by an AI agent."}},"CustomFieldItem":{"type":"object","required":["title","value"],"properties":{"title":{"type":"string","description":"The display title of the custom field."},"description":{"type":"string","description":"An optional description of the field. Defaults to an empty string in the backend.","default":""},"value":{"type":"string","description":"The string value associated with this custom field."}},"description":"Schema for a single custom field item."},"CustomerBuyerPersonaAttributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Name of the buyer persona. Required when creating a new record. When provided (for create or update), must be between 1 and 1024 characters."},"description":{"type":"string","maxLength":10000,"description":"Detailed description of this buyer persona, including their role, responsibilities, and relevance to the sales process. Maximum 10,000 characters."},"personalObjectives":{"type":"string","maxLength":10000,"description":"Personal objectives for this persona such as career goals, KPIs, and success metrics that drive their purchasing decisions. Maximum 10,000 characters."},"whatDoesThisPersonaCareAbout":{"type":"string","maxLength":10000,"description":"Messaging angle explaining what this persona cares about in the customer's offering. Maximum 10,000 characters."},"titlesFunctionsSeniority":{"type":"string","maxLength":10000,"description":"Typical job titles, functional areas, and seniority levels associated with this persona. Maximum 10,000 characters."},"relevantOfferings":{"type":"string","maxLength":10000,"description":"Relevant offerings from the customer's portfolio that this persona would be interested in. Maximum 10,000 characters."},"source":{"allOf":[{"$ref":"#/components/schemas/GtmConfigSourceType"}],"description":"Source type indicating how this persona record was created or last modified. Defaults to `manual`. See `GtmConfigSourceType` for allowed values. When set explicitly, the backend validates source consistency with the `created_by` and `updated_by` fields.","readOnly":true},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldItem"},"description":"Flexible key-value store for customer-specific custom fields and extended metadata. The backend validates schema and value types. Use this to capture additional persona attributes beyond the standard fields."}},"description":"Attributes that define a customer buyer persona — a profile representing a type of buyer\nthat the customer's sales team targets. Buyer personas capture who the ideal buyers are,\nwhat motivates them, and how to engage them effectively."},"GtmConfigAuditFields":{"type":"object","properties":{"createdAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the record was originally created. Auto-populated by backend.","readOnly":true},"updatedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp of the most recent modification to the record. Auto-populated by backend.","readOnly":true},"createdBy":{"type":"string","description":"User ID of the person who created the record. Extracted from the JWT token on creation.","readOnly":true},"updatedBy":{"type":"string","description":"User ID of the person who last modified the record. Extracted from the JWT token on update.","readOnly":true},"archivedAt":{"type":"string","format":"date-time","description":"ISO 8601 timestamp when the record was archived. Archived records are identified by archivedAt and archivedBy","readOnly":true},"archivedBy":{"type":"string","description":"User ID of the person who archived the record","readOnly":true}},"description":"Common audit fields present on all customer-level GTM configuration entities.\nThese fields track the full lifecycle of a record including creation, modification,\narchival (temporary hiding), and soft deletion (permanent hiding for compliance).\nA record can be active, deleted only, or both."},"CustomerBuyerPersona":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CustomerBuyerPersona","pattern":"CustomerBuyerPersona"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerBuyerPersonaAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource","readOnly":true}},"description":"Customer Buyer Persona resource."},"CustomerBuyerPersonaListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerBuyerPersona"},"description":"The primary data of the document"}},"description":"API model for a list of customer buyer personas."},"CustomerBuyerPersonaModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CustomerBuyerPersona"}],"description":"The primary data of the document"}},"description":"API model for a single customer buyer persona."},"CustomerBuyerPersonaUpsert":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","enum":["CustomerBuyerPersona"],"description":"The type of the resource"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerBuyerPersonaAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource"}},"x-discriminator-property":"type","description":"The primary data of the document"}},"description":"Customer Buyer Persona resource for upsert operations."},"CustomerCompetitorAttributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Name of the competitor company. Required when creating a new record. When provided (for create or update), must be between 1 and 1024 characters."},"description":{"type":"string","maxLength":10000,"description":"Detailed description of the competitor, including market position, strengths, and relevance to the customer's business. Maximum 10,000 characters."},"url":{"type":"string","format":"uri","description":"URL of the competitor's website. Maximum 1024 characters."},"competitorProducts":{"type":"string","maxLength":10000,"description":"Description of the products or services this competitor offers that overlap with the customer's portfolio. Maximum 10,000 characters."},"reasonsTheyWin":{"type":"string","maxLength":10000,"description":"Analysis of why this competitor wins deals, covering key strengths, differentiators, and advantages in competitive situations. Maximum 10,000 characters."},"reasonsTheyLose":{"type":"string","maxLength":10000,"description":"Analysis of why this competitor loses deals, covering weaknesses, gaps, and areas where the customer holds an advantage. Maximum 10,000 characters."},"customersWeWon":{"type":"string","maxLength":10000,"description":"Accounts that the customer has won from this competitor. Useful for case-study development and competitive proof points. Maximum 10,000 characters."},"competitiveProducts":{"type":"string","maxLength":10000,"description":"The customer's own products that directly compete with this competitor's products or services. Useful for competitive mapping and battle-card generation. Maximum 10,000 characters."},"source":{"allOf":[{"$ref":"#/components/schemas/GtmConfigSourceType"}],"description":"Source type indicating how this competitor record was created or last modified. Defaults to `manual`. See `GtmConfigSourceType` for allowed values. When set explicitly, the backend validates source consistency with the `created_by` and `updated_by` fields.","readOnly":true},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldItem"},"description":"Flexible key-value store for customer-specific custom fields and extended metadata. The backend validates schema and value types. Use this to capture additional competitor intelligence beyond the standard fields."}},"description":"Attributes that define a Customer Competitor — a company that competes with the customer in the market."},"CustomerCompetitor":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CustomerCompetitor","pattern":"CustomerCompetitor"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerCompetitorAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource","readOnly":true}},"description":"Customer Competitor resource."},"CustomerCompetitorListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerCompetitor"},"description":"The primary data of the document"}},"description":"API model for a list of Customer Competitors."},"CustomerCompetitorModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CustomerCompetitor"}],"description":"The primary data of the document"}},"description":"API model for a single Customer Competitor."},"CustomerCompetitorUpsert":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","enum":["CustomerCompetitor"],"description":"The type of the resource"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerCompetitorAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource"}},"x-discriminator-property":"type","description":"The primary data of the document"}},"description":"Customer Competitor resource for upsert operations."},"IdealCompanySegmentAttributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Name of the Ideal Customer Profile (e.g., 'Enterprise SaaS', 'Mid-Market Financial Services'). Required when creating a new record. When provided (for create or update), must be between 1 and 1024 characters."},"description":{"type":"string","maxLength":10000,"description":"Description of the profile. Typically includes industry, company size, revenue range, geography, etc. Maximum 10,000 characters."},"source":{"allOf":[{"$ref":"#/components/schemas/GtmConfigSourceType"}],"description":"Source type indicating how this profile record was created or last modified. Defaults to `manual`. See `GtmConfigSourceType` for allowed values. When set explicitly, the backend validates source consistency with the `created_by` and `updated_by` fields.","readOnly":true},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldItem"},"description":"Flexible key-value store for customer-specific custom fields and extended metadata. The backend validates schema and value types. Use this to capture additional profile criteria beyond the standard fields."}},"description":"Attributes that define an ideal company segment/Ideal Customer Profile.\n\nIdeal company segments/Ideal Customer Profile describe the types of companies a customer wants to target. \nThis typically contains industry, company size, revenue range, geography, etc."},"IdealCompanySegment":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"IdealCompanySegment","pattern":"IdealCompanySegment"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IdealCompanySegmentAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource","readOnly":true}},"description":"Ideal Customer Profile resource."},"IdealCompanySegmentListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/IdealCompanySegment"},"description":"The primary data of the document"}},"description":"API model for a list of Ideal Customer Profiles."},"IdealCompanySegmentModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/IdealCompanySegment"}],"description":"The primary data of the document"}},"description":"API model for a single Ideal Customer Profile."},"IdealCompanySegmentUpsert":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","enum":["IdealCompanySegment"],"description":"The type of the resource"},"attributes":{"allOf":[{"$ref":"#/components/schemas/IdealCompanySegmentAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource"}},"x-discriminator-property":"type","description":"The primary data of the document"}},"description":"Ideal Customer Profile resource for upsert operations."},"CustomerSettingsAttributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Editable display name for the customer organization. When provided (for create or update), must be between 1 and 1024 characters."},"elevatorPitch":{"type":"string","maxLength":1024,"description":"Brief elevator pitch or value proposition for the customer organization. Used by AI agents to understand the company's core offering. When provided (for create or update), must be less than 1024 characters."},"description":{"type":"string","maxLength":10000,"description":"Company description providing context about what the organization does, its market position, and its target audience. Maximum 10,000 characters."},"strategicPriorities":{"type":"string","maxLength":10000,"description":"Strategic priorities text describing the organization's key business objectives, growth targets, and focus areas. Used by AI agents to align GTM recommendations with business goals. Maximum 10,000 characters."},"source":{"allOf":[{"$ref":"#/components/schemas/GtmConfigSourceType"}],"description":"Source type indicating how this settings record was created or last modified. Defaults to `manual`. See `GtmConfigSourceType` for allowed values.","readOnly":true},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldItem"},"description":"Flexible key-value storage for customer-specific custom fields and metadata. The backend validates the schema and value types. This allows storing organization-specific data beyond the standard fields."}},"description":"Attributes defining customer-level settings and configuration"},"CustomerSettings":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"CustomerSettings","pattern":"CustomerSettings"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerSettingsAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource","readOnly":true}},"description":"Customer Settings resource wrapping attributes in JSON:API format."},"CustomerSettingsModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CustomerSettings"}],"description":"The primary data of the document"}},"description":"JSON:API response containing the customer settings singleton."},"CustomerSettingsCreate":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"CustomerSettings","pattern":"CustomerSettings"},"attributes":{"allOf":[{"$ref":"#/components/schemas/CustomerSettingsAttributes"}],"description":"The attributes defining the resource"}},"description":"Customer Settings resource wrapping attributes in JSON:API format."},"CustomerSettingsModelCreate":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/CustomerSettingsCreate"}],"description":"The primary data of the document"}},"description":"JSON:API response containing the customer settings singleton."},"OrganizationOfferingAttributes":{"type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":1024,"description":"Name of the Product or Service. Required when creating a new record. When provided (for create or update), must be between 1 and 1024 characters."},"description":{"type":"string","maxLength":10000,"description":"Detailed description of the Product or Service, including its purpose, target audience, and key benefits. Maximum 10,000 characters."},"painPoints":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Customer pain points this Product or Service addresses."},"valueProposition":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Value propositions as articulated by the customer — the key reasons a buyer should choose this Product or Service."},"proofPoints":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Reviews, testimonials, or case-study references that validate the Product or Service's effectiveness."},"url":{"type":"string","format":"uri","description":"URL of the Product or Service's webpage or landing page. Maximum 1024 characters."},"competitors":{"type":"string","maxLength":10000,"description":"Text description of competitor information relevant to this specific Product or Service. Maximum 10,000 characters."},"idealCompanySegment":{"type":"string","maxLength":10000,"description":"Text description of the ideal company segment for this Product or Service. Maximum 10,000 characters."},"offeringBuyerPersonas":{"type":"string","maxLength":10000,"description":"Text description of the buyer personas relevant to this Product or Service. Maximum 10,000 characters."},"source":{"allOf":[{"$ref":"#/components/schemas/GtmConfigSourceType"}],"description":"Source type indicating how this Product or Service record was created or last modified. Defaults to `manual`. See `GtmConfigSourceType` for allowed values. When set explicitly, the backend validates source consistency with the `created_by` and `updated_by` fields.","readOnly":true},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomFieldItem"},"description":"Flexible key-value store for customer-specific custom fields and extended metadata. The backend validates schema and value types. Use this to capture additional Product or Service details beyond the standard fields."}},"description":"Attributes that define a Product or Service  — the discrete products or services provided by a customer's company.\n\nProducts or services form the foundation of a customer's go-to-market configuration, capturing the essential strategic context of a product. \nA product or service serves as a centralized record for:\n\n* Product Positioning: Capturing how the product is uniquely situated in the market.\n* Targeting: Identifying the specific audiences, industries, or company types the product is intended for.\n* Pain Point Resolution: Documenting the specific customer problems or challenges the product or service is designed to address.\n* Value Proposition: Defining the core benefits and outcomes the product or service provides to the customer.\n\nCollectively, these attributes provide the necessary framework to build a complete GTM picture. The product or service acts as the \nprimary anchor to which Buyer Personas, Ideal Customer Profiles, and Competitive Intelligence are linked, ensuring all \nrevenue-generating activities are aligned with the product's strategic intent."},"OrganizationOffering":{"type":"object","required":["id","type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","description":"The type of the resource","default":"OrganizationOffering","pattern":"OrganizationOffering"},"attributes":{"allOf":[{"$ref":"#/components/schemas/OrganizationOfferingAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource","readOnly":true}},"description":"Product or Service resource."},"OrganizationOfferingListResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationOffering"},"description":"The primary data of the document"}},"description":"API model for a list of products or services."},"OrganizationOfferingModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/OrganizationOffering"}],"description":"The primary data of the document"}},"description":"API model for a single product or service."},"OrganizationOfferingUpsert":{"type":"object","required":["data"],"properties":{"data":{"type":"object","required":["type","attributes"],"properties":{"id":{"type":"string","description":"The unique identifier for the resource"},"type":{"type":"string","enum":["OrganizationOffering"],"description":"The type of the resource"},"attributes":{"allOf":[{"$ref":"#/components/schemas/OrganizationOfferingAttributes"}],"description":"The attributes defining the resource"},"meta":{"allOf":[{"$ref":"#/components/schemas/GtmConfigAuditFields"}],"description":"Non-standard meta information about the resource"}},"x-discriminator-property":"type","description":"The primary data of the document"}},"description":"Product or Service resource for upsert operations."},"BaseSignalPayload":{"type":"object","required":["displayText","date"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."}},"description":"Base interface for all signal payloads containing common fields."},"CompanySignalPayload":{"type":"object","required":["displayText","date","ziCompanyId"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."}},"description":"Base model for company-related signal payloads."},"ContactSignalPayload":{"type":"object","required":["displayText","date","ziCompanyId","ziContactId","name"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"ziCompanyId":{"type":"integer","format":"int64","description":"ZoomInfo company id."},"ziContactId":{"type":"integer","format":"int64","description":"ZoomInfo contact id for the person."},"name":{"type":"string","description":"Name of the person associated with this signal."},"title":{"type":"string","description":"Person's job title."},"isPersonOfInterest":{"type":"boolean","description":"Indicates if this person was identified as a contact of interest."},"isCLevel":{"type":"boolean","description":"Indicates if the person holds a C-level executive position."},"inBuyingGroup":{"type":"boolean","description":"Indicates if the person is part of an identified buying committee or decision-making group."}},"description":"Base model for contact-related signal payloads."},"TextBasedSignalPayload":{"type":"object","required":["displayText","date","text"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"text":{"type":"string","description":"The text content of the signal."}},"description":"Generic text-based signal payload for news and announcements."},"EngagementTrackingSignalPayload":{"type":"object","required":["displayText","date","engagedContactsCount","lastEngagementDate"],"properties":{"displayText":{"type":"string","description":"Text describing this signal for display purposes."},"date":{"type":"string","format":"date-time","description":"UTC timestamp when the signal event was originally recorded or detected."},"engagedContactsCount":{"type":"integer","format":"int64","description":"Number of contacts at this account who have been engaged (via CRM or Chorus activity) on the open opportunity."},"lastEngagementDate":{"type":"string","format":"date-time","description":"UTC timestamp of the most recent engagement activity detected on the open opportunity."}},"description":"Engagement tracking signal payload."},"Versions":{"type":"string","enum":["1.0"]}},"securitySchemes":{"OAuth2Auth":{"type":"oauth2","flows":{"authorizationCode":{"authorizationUrl":"https://login.zoominfo.com","tokenUrl":"https://okta-login.zoominfo.com/oauth2/default/v1/token","scopes":{"api:account-summary:read":"Read Copilot Account Summary Data","api:insights:read":"Read Insights Data","api:recommendations:read":"Read Copilot recommendation data","api:gtm-config:read":"Read GTM configuration data","api:gtm-config:manage":"Manage GTM configuration data (create, update, delete)"}}}}}},"servers":[{"url":"https://api.zoominfo.com/gtm","description":"Base URL for the Copilot API"}]}