ZoomInfo Marketing API

{"openapi":"3.0.0","info":{"title":"Marketing API V1","version":"1.0","contact":{"name":"ZoomInfo Customer Support","email":"help@zoominfo.com"},"description":"The ZoomInfo Marketing API."},"tags":[{"name":"Audiences"}],"paths":{"/marketing/v1/audiences":{"post":{"operationId":"AudienceInterface_createAudience","summary":"Creates a new audience","description":"Creates a new audience.","parameters":[],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceModel"}}}},"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":["Audiences"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceModelCreate"}}},"description":"Request body containing the audience creation details"},"security":[{"OAuth2Auth":["api:audience:manage"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:mcp"]},"get":{"operationId":"AudienceInterface_getAudiences","summary":"Lists all audiences","description":"Lists all audiences.","parameters":[{"name":"pageToken","in":"query","required":false,"description":"The page token to use for pagination","schema":{"type":"string"},"explode":false},{"name":"pageSize","in":"query","required":false,"description":"The number of audiences to return per page","schema":{"type":"integer","format":"int32"},"explode":false}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/GetAudiencesResponse"}}}},"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":["Audiences"],"security":[{"OAuth2Auth":["api:audience:read"]}],"x-api-roles":["fea:mcp"]}},"/marketing/v1/audiences/{audienceId}":{"get":{"operationId":"AudienceInterface_getAudience","summary":"Gets existing audience by ID","description":"Gets an existing audience.","parameters":[{"name":"audienceId","in":"path","required":true,"description":"The unique identifier of the audience","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceModel"}}}},"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":["Audiences"],"security":[{"OAuth2Auth":["api:audience:read"]}],"x-api-roles":["fea:mcp"]},"put":{"operationId":"AudienceInterface_updateAudience","summary":"Updates audience by ID","description":"Updates an existing audience.","parameters":[{"name":"audienceId","in":"path","required":true,"description":"The unique identifier of the audience","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceModel"}}}},"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":["Audiences"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceModelUpdate"}}},"description":"Request body containing the audience update details"},"security":[{"OAuth2Auth":["api:audience:manage"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:mcp"]},"delete":{"operationId":"AudienceInterface_deleteAudience","summary":"Deletes audience by ID","description":"Deletes an existing audience.","parameters":[{"name":"audienceId","in":"path","required":true,"description":"The unique identifier of the audience","schema":{"type":"string"}}],"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":["Audiences"],"security":[{"OAuth2Auth":["api:audience:manage"]}],"x-api-roles":["fea:mcp"]}},"/marketing/v1/audiences/{audienceId}/uploads":{"post":{"operationId":"AudienceInterface_uploadAudience","summary":"Creates new audience upload","description":"Create a new audience segment upload.","parameters":[{"name":"audienceId","in":"path","required":true,"description":"The unique identifier of the audience","schema":{"type":"string"}}],"responses":{"201":{"description":"Created","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceUploadModel"}}}},"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":["Audiences"],"requestBody":{"required":true,"content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceUploadModelCreate"}}},"description":"Request body containing the audience upload details"},"security":[{"OAuth2Auth":["api:audience-member:manage"]}],"x-additional-content-types":["application/json"],"x-api-roles":["fea:mcp"]}},"/marketing/v1/audiences/{audienceId}/uploads/{uploadId}":{"get":{"operationId":"AudienceInterface_getAudienceUpload","summary":"Gets audience upload status","description":"Gets the upload status for an existing audience.","parameters":[{"name":"audienceId","in":"path","required":true,"description":"The unique identifier of the audience","schema":{"type":"string"}},{"name":"uploadId","in":"path","required":true,"description":"The unique identifier of the audience upload","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/vnd.api+json":{"schema":{"$ref":"#/components/schemas/AudienceUploadModel"}}}},"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":["Audiences"],"security":[{"OAuth2Auth":["api:audience-member:manage"]}],"x-api-roles":["fea:mcp"]}}},"security":[{"OAuth2Auth":[]}],"components":{"schemas":{"AudienceType":{"type":"string","enum":["B2B","B2C"]},"AudienceStatus":{"type":"string","enum":["ACTIVE","ARCHIVED"]},"AudienceAttributes":{"type":"object","required":["name","type","status"],"properties":{"name":{"type":"string","description":"The name of the audience"},"type":{"allOf":[{"$ref":"#/components/schemas/AudienceType"}],"description":"The audience type defining whether the audience is targeting businesses (B2B) or consumers (B2C)"},"status":{"allOf":[{"$ref":"#/components/schemas/AudienceStatus"}],"description":"The status of the audience","readOnly":true}},"description":"Attributes defining a ZoomInfo Audience"},"Audience":{"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":"Audience","pattern":"Audience"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AudienceAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Audience"},"AudienceModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/Audience"}],"description":"The primary data of the document"}},"description":"Response containing a single ZoomInfo Audience"},"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."},"AudienceCreate":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"Audience","pattern":"Audience"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AudienceAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Audience"},"AudienceModelCreate":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AudienceCreate"}],"description":"The primary data of the document"}},"description":"Response containing a single ZoomInfo Audience"},"GetAudiencesMeta":{"type":"object","required":["page","pageSize","totalCount"],"properties":{"page":{"type":"integer","format":"uint32","description":"The current page of audiences being returned"},"pageSize":{"type":"integer","format":"uint32","description":"The page size as specified by the request"},"totalCount":{"type":"integer","format":"uint32","description":"The total count of audience within the current search parameters"}},"description":"Metadata for the current page of audiences returned"},"GetAudiencesLinks":{"type":"object","properties":{"first":{"type":"string","format":"uri","description":"A link to the first page of data"},"last":{"type":"string","format":"uri","description":"A link to the last page of data"},"prev":{"type":"string","format":"uri","description":"A link to the previous page of data"}},"description":"Links describing the various audience paging options"},"GetAudiencesResponse":{"type":"object","required":["data"],"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Audience"},"description":"The primary data of the document"},"meta":{"allOf":[{"$ref":"#/components/schemas/GetAudiencesMeta"}],"description":"Non-standard meta information about the document"},"links":{"allOf":[{"$ref":"#/components/schemas/GetAudiencesLinks"}],"description":"Links related to the primary data"}},"description":"A paged list of ZoomInfo Audiences"},"AudienceAttributesUpdate":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the audience"}},"description":"Attributes defining a ZoomInfo Audience"},"AudienceUpdate":{"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":"Audience","pattern":"Audience"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AudienceAttributesUpdate"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Audience"},"AudienceModelUpdate":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AudienceUpdate"}],"description":"The primary data of the document"}},"description":"Response containing a single ZoomInfo Audience"},"UploadOperationType":{"type":"string","enum":["ADD","DELETE"],"description":"The type of upload","x-enumDescriptions":{"ADD":"Adds the member upload to audience","DELETE":"Removes the records from an audience"}},"UploadStatus":{"type":"string","enum":["IN_PROGRESS","COMPLETE","FAILED"],"description":"The various status values for an audience member upload"},"AudienceUploadAttributes":{"type":"object","required":["operationType","createDate","updateDate","status"],"properties":{"operationType":{"allOf":[{"$ref":"#/components/schemas/UploadOperationType"}],"description":"Define the type of operation that this upload will perform for the audience. Add - add records to the audiences, Delete - delete records from the audience"},"createDate":{"type":"string","format":"date-time","description":"The create date of the upload","readOnly":true},"updateDate":{"type":"string","format":"date-time","description":"The last update date of the upload","readOnly":true},"completeDate":{"type":"string","format":"date-time","description":"The completion date of upload","readOnly":true},"status":{"allOf":[{"$ref":"#/components/schemas/UploadStatus"}],"description":"The status of the upload","readOnly":true}},"description":"Attributes defining an audience member upload"},"AudienceUpload":{"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":"AudienceUpload","pattern":"AudienceUpload"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AudienceUploadAttributes"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Audience Upload"},"AudienceUploadModel":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AudienceUpload"}],"description":"The primary data of the document"}},"description":"Request/Response wrapper for a ZoomInfo Audience Upload"},"UploadField":{"type":"string","enum":["ziCompanyId","ziPersonId","firstName","lastName","emailAddress","companyName","companyUrl"],"description":"Enumeration of allowed field names for records."},"AudienceUploadAttributesCreate":{"type":"object","required":["operationType","fields","records"],"properties":{"operationType":{"allOf":[{"$ref":"#/components/schemas/UploadOperationType"}],"description":"Define the type of operation that this upload will perform for the audience. Add - add records to the audiences, Delete - delete records from the audience"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/UploadField"},"description":"Define the schema of the records by selecting which fields are included in each record"},"records":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"The list of records matching the exact order of the schema defined in fields"}},"description":"Attributes defining an audience member upload"},"AudienceUploadCreate":{"type":"object","required":["type","attributes"],"properties":{"type":{"type":"string","description":"The type of the resource","default":"AudienceUpload","pattern":"AudienceUpload"},"attributes":{"allOf":[{"$ref":"#/components/schemas/AudienceUploadAttributesCreate"}],"description":"The attributes defining the resource"}},"description":"ZoomInfo Audience Upload"},"AudienceUploadModelCreate":{"type":"object","required":["data"],"properties":{"data":{"allOf":[{"$ref":"#/components/schemas/AudienceUploadCreate"}],"description":"The primary data of the document"}},"description":"Request/Response wrapper for a ZoomInfo Audience Upload"},"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:audience:manage":"Create and Manage Audiences","api:audience:read":"Read Audiences","api:audience-member:manage":"Create and manage audience members"}}}}}},"servers":[{"url":"https://api.zoominfo.com/gtm","description":"Base URL for the Marketing API"}]}