{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:hubapi-communication-preferences/get-communication-preferences-2026-09-definitions":{"get":{"operationId":"open_data_hubapi_communication_preferences_get_communication_preferences_2026_09_definitions","summary":"Retrieve all subscription status definitions","description":"GET /communication-preferences/2026-09/definitions","tags":["open-data"],"parameters":[{"name":"businessUnitId","in":"query","required":false,"description":"An integer representing the unique identifier of the business unit for which to retrieve communication preferences definitions.","schema":{"type":"integer","description":"An integer representing the unique identifier of the business unit for which to retrieve communication preferences definitions."}},{"name":"includeTranslations","in":"query","required":false,"description":"A boolean indicating whether to include translations for the subscription definitions. Defaults to false if not specified.","schema":{"type":"boolean","description":"A boolean indicating whether to include translations for the subscription definitions. Defaults to false if not specified."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-links-generate-commun":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_links_generate_commun","summary":"Generate subscription links","description":"POST /communication-preferences/2026-09/links/generate","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","body"],"properties":{"channel":{"type":"string","enum":["EMAIL"],"description":"The communication channel for which the links are generated. Currently, only 'EMAIL' is supported."},"businessUnitId":{"type":"integer","default":0,"description":"The ID of the business unit for which the links are generated. It is an optional parameter and defaults to 0."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-batch-read":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_batch_read","summary":"Batch retrieve subscription statuses","description":"POST /communication-preferences/2026-09/statuses/batch/read","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","body"],"properties":{"channel":{"type":"string","enum":["EMAIL"],"description":"A required string specifying the communication channel. Currently, only 'EMAIL' is supported."},"businessUnitId":{"type":"integer","description":"An optional integer representing the business unit ID. This parameter helps in filtering the results based on a specific business unit."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-batch-unsubs":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_batch_unsubs","summary":"Batch unsubscribe contacts from all subscriptions","description":"POST /communication-preferences/2026-09/statuses/batch/unsubscribe-all","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","body"],"properties":{"channel":{"type":"string","enum":["EMAIL"],"description":"The communication channel from which to unsubscribe all subscribers. This parameter is required and currently supports only 'EMAIL'."},"businessUnitId":{"type":"integer","description":"The ID of the business unit for which the operation is being performed. This is an optional parameter."},"verbose":{"type":"boolean","default":false,"description":"A boolean flag indicating whether to include detailed information in the response. Defaults to false."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-batch-unsubs-2":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_batch_unsubs_2","summary":"Batch retrieve contacts who have opted out of all communications","description":"POST /communication-preferences/2026-09/statuses/batch/unsubscribe-all/read","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["channel","body"],"properties":{"channel":{"type":"string","enum":["EMAIL"],"description":"A required string specifying the communication channel. Currently, only 'EMAIL' is supported."},"businessUnitId":{"type":"integer","description":"An optional integer representing the business unit ID to filter the results."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-batch-write":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_batch_write","summary":"Batch update subscription status","description":"POST /communication-preferences/2026-09/statuses/batch/write","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/get-communication-preferences-2026-09-statuses-subscriber-id":{"get":{"operationId":"open_data_hubapi_communication_preferences_get_communication_preferences_2026_09_statuses_subscriber_id","summary":"Get subscription preferences for a specific contact","description":"GET /communication-preferences/2026-09/statuses/{subscriberIdString}","tags":["open-data"],"parameters":[{"name":"subscriberIdString","in":"query","required":true,"description":"The unique identifier of the subscriber whose communication preferences status is being retrieved.","schema":{"type":"string","description":"The unique identifier of the subscriber whose communication preferences status is being retrieved."}},{"name":"channel","in":"query","required":true,"description":"The communication channel for which the subscription status is being retrieved. Must be 'EMAIL'.","schema":{"type":"string","enum":["EMAIL"],"description":"The communication channel for which the subscription status is being retrieved. Must be 'EMAIL'."}},{"name":"businessUnitId","in":"query","required":false,"description":"The ID of the business unit to filter the subscription status. This is an optional parameter.","schema":{"type":"integer","description":"The ID of the business unit to filter the subscription status. This is an optional parameter."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-subscriber-i":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_subscriber_i","summary":"Update a contact's subscription status","description":"POST /communication-preferences/2026-09/statuses/{subscriberIdString}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriberIdString","body"],"properties":{"subscriberIdString":{"type":"string","description":"The unique identifier of the subscriber whose communication preferences status is to be updated."},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/get-communication-preferences-2026-09-statuses-subscriber-id-2":{"get":{"operationId":"open_data_hubapi_communication_preferences_get_communication_preferences_2026_09_statuses_subscriber_id_2","summary":"Retrieve a contact's unsubscribed status","description":"GET /communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all","tags":["open-data"],"parameters":[{"name":"subscriberIdString","in":"query","required":true,"description":"The unique identifier of the subscriber whose unsubscribe status is being retrieved.","schema":{"type":"string","description":"The unique identifier of the subscriber whose unsubscribe status is being retrieved."}},{"name":"channel","in":"query","required":true,"description":"The communication channel for which the unsubscribe status is being checked. Must be 'EMAIL'.","schema":{"type":"string","enum":["EMAIL"],"description":"The communication channel for which the unsubscribe status is being checked. Must be 'EMAIL'."}},{"name":"businessUnitId","in":"query","required":false,"description":"An optional integer representing the business unit ID.","schema":{"type":"integer","description":"An optional integer representing the business unit ID."}},{"name":"verbose","in":"query","required":false,"description":"A boolean indicating whether to include detailed information. Defaults to false.","schema":{"type":"boolean","default":false,"description":"A boolean indicating whether to include detailed information. Defaults to false."}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:hubapi-communication-preferences/post-communication-preferences-2026-09-statuses-subscriber-i-2":{"post":{"operationId":"open_data_hubapi_communication_preferences_post_communication_preferences_2026_09_statuses_subscriber_i_2","summary":"Unsubscribe a contact from all subscriptions","description":"POST /communication-preferences/2026-09/statuses/{subscriberIdString}/unsubscribe-all","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["subscriberIdString","channel"],"properties":{"subscriberIdString":{"type":"string","description":"The unique identifier of the subscriber to unsubscribe."},"channel":{"type":"string","enum":["EMAIL"],"description":"The communication channel to unsubscribe from. Must be 'EMAIL'."},"businessUnitId":{"type":"integer","description":"An optional integer representing the business unit ID."},"verbose":{"type":"boolean","default":false,"description":"An optional boolean to include detailed information in the response. Defaults to false."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}