{"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/communication:suprsend/template-get-list":{"get":{"operationId":"communication_suprsend_template_get_list","summary":"Fetch Template List","description":"GET /v1/template","tags":["communication"],"parameters":[{"name":"has_tag_ids_any","in":"query","required":false,"description":"comma separated string of tag ids attached to the template","schema":{"type":"string","description":"comma separated string of tag ids attached to the template"}},{"name":"has_channels_any","in":"query","required":false,"description":"comma separated string of channels. Returns templates which has any of the channels present from the channel string. Use these keys for…","schema":{"type":"string","description":"comma separated string of channels. Returns templates which has any of the channels present from the channel string. Use these keys for…"}},{"name":"is_active","in":"query","required":false,"description":"Set `true` for published templates, `false` for templates which are in draft. Do not pass this key to return all templates.","schema":{"type":"boolean","description":"Set `true` for published templates, `false` for templates which are in draft. Do not pass this key to return all templates."}},{"name":"is_archived","in":"query","required":false,"description":"Set `true` to get archived templates, default = `false`","schema":{"type":"boolean","description":"Set `true` to get archived templates, default = `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/communication:suprsend/template-get-details":{"get":{"operationId":"communication_suprsend_template_get_details","summary":"Fetch Template details","description":"GET /v1/template/{template_slug}","tags":["communication"],"parameters":[{"name":"template_slug","in":"query","required":true,"description":"Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name…","schema":{"type":"string","description":"Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name…"}}],"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/communication:suprsend/template-get-content-channel":{"get":{"operationId":"communication_suprsend_template_get_content_channel","summary":"Fetch Template content for a channel","description":"GET /v1/template/{template_slug}/channel/{channel_slug}","tags":["communication"],"parameters":[{"name":"template_slug","in":"query","required":true,"description":"Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name…","schema":{"type":"string","description":"Template group slug you want to fetch content details. You'll get the template slug by clicking on copy button next to template group name…"}},{"name":"channel_slug","in":"query","required":true,"description":"add one of the template channels - `email`, `sms`, `whatsapp`, `inbox`, `slack`, `androidpush`, `iospush`, `webpush`","schema":{"type":"string","description":"add one of the template channels - `email`, `sms`, `whatsapp`, `inbox`, `slack`, `androidpush`, `iospush`, `webpush`"}}],"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/communication:suprsend/brand-brand-data-get":{"get":{"operationId":"communication_suprsend_brand_brand_data_get","summary":"Get Brand data","description":"GET /v1/brand/{brand_id}","tags":["communication"],"parameters":[{"name":"brand_id","in":"query","required":true,"description":"unique identifier of the brand you want to get the details for","schema":{"type":"string","description":"unique identifier of the brand you want to get the details for"}}],"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/communication:suprsend/brand-create-or-update":{"post":{"operationId":"communication_suprsend_brand_create_or_update","summary":"Create / Update Brands","description":"POST /v1/brand/{brand_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["brand_id"],"properties":{"brand_id":{"type":"string","description":"unique identifier of the brand that you want to create / update"},"Content - Type":{"type":"string"},"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/communication:suprsend/subscriber-update-user-preferences-category":{"post":{"operationId":"communication_suprsend_subscriber_update_user_preferences_category","summary":"Update User Preferences (Category level)","description":"POST /v1/subscriber/{distinct_id}/category/{category_slug}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["distinct_id","category_slug"],"properties":{"distinct_id":{"type":"string","description":"distinct_id of the user whose preferences should be fetched"},"tenant_id":{"type":"string","description":"to fetch user preferences for a particular brand"},"category_slug":{"type":"string","description":"notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page"},"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/communication:suprsend/subscriber-add-to-list":{"post":{"operationId":"communication_suprsend_subscriber_add_to_list","summary":"Add Subscribers to List","description":"POST /v1/subscriber_list/{list_id}/subscriber/add","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list to which user needs 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/communication:suprsend/subscriber-list-remove-subscribers-from-list":{"post":{"operationId":"communication_suprsend_subscriber_list_remove_subscribers_from_list","summary":"Remove Subscribers from List","description":"POST /v1/subscriber_list/{list_id}/subscriber/remove","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list to which user needs 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/communication:suprsend/subscriber-list-delete-list":{"post":{"operationId":"communication_suprsend_subscriber_list_delete_list","summary":"Delete List","description":"PATCH /v1/subscriber_list/{list_id}/delete","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"string","description":"Unique string idenitifier of the list which you want to delete"}}}}}},"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/communication:suprsend/subscriber-delete-draft-list":{"post":{"operationId":"communication_suprsend_subscriber_delete_draft_list","summary":"Delete Draft List","description":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/delete","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","version_id"],"properties":{"list_id":{"type":"string","description":"Unique string idenitifier of the list which you want to delete"},"version_id":{"type":"string","default":"__version_id__","description":"Unique identifier of the draft version of the list which needs to be deleted"}}}}}},"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/communication:suprsend/sync-list-start-sync":{"post":{"operationId":"communication_suprsend_sync_list_start_sync","summary":"Start Sync","description":"POST /v1/subscriber_list/{list_id}/start_sync","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique identifier of the list on which the sync needs to start to create a draft version"}}}}}},"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/communication:suprsend/subscriber-add-to-draft-list":{"post":{"operationId":"communication_suprsend_subscriber_add_to_draft_list","summary":"Add Subscribers to Draft List","description":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/add","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","version_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list to which user needs to be updated"},"version_id":{"type":"string","default":"__version_id__","description":"Unique string idenitifier of the draft version of the list to which user needs 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/communication:suprsend/subscriber-remove-from-draft-list":{"post":{"operationId":"communication_suprsend_subscriber_remove_from_draft_list","summary":"Remove Subscribers from Draft List","description":"POST /v1/subscriber_list/{list_id}/version/{version_id}/subscriber/remove","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","version_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list to which user needs to be updated"},"version_id":{"type":"string","default":"__version_id__","description":"Unique string idenitifier of the draft version of the list to which user needs 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/communication:suprsend/subscriber-finish-sync-draft-version":{"post":{"operationId":"communication_suprsend_subscriber_finish_sync_draft_version","summary":"Finish Sync","description":"PATCH /v1/subscriber_list/{list_id}/version/{version_id}/finish_sync","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["list_id","version_id"],"properties":{"list_id":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list"},"version_id":{"type":"string","default":"__version_id__","description":"Unique string idenitifier of the draft version of the list which needs to be made active(live)"}}}}}},"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/communication:suprsend/broadcast-trigger-message-list":{"post":{"operationId":"communication_suprsend_broadcast_trigger_message_list","summary":"Trigger Broadcast","description":"POST /{workspace_key}/broadcast","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspace_key"],"properties":{"workspace_key":{"type":"string"},"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/communication:suprsend/event-trigger-event":{"post":{"operationId":"communication_suprsend_event_trigger_event","summary":"Trigger an Event","description":"POST /event","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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/communication:suprsend/workflow-configure-trigger":{"post":{"operationId":"communication_suprsend_workflow_configure_trigger","summary":"Trigger Workflow","description":"POST /{workspace_key}/trigger","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["workspace_key"],"properties":{"workspace_key":{"type":"string"},"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/communication:suprsend/brand-list-get":{"get":{"operationId":"communication_suprsend_brand_list_get","summary":"Get Brand list","description":"GET /v1/brand","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"number of results to be returned in API response","schema":{"type":"string","default":"20","description":"number of results to be returned in API response"}},{"name":"offset","in":"query","required":false,"description":"starting position of brand list","schema":{"type":"string","default":"0","description":"starting position of brand list"}}],"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/communication:suprsend/preference-get-user-channel-preferences":{"get":{"operationId":"communication_suprsend_preference_get_user_channel_preferences","summary":"Get User Preferences (Channel level)","description":"GET /v1/subscriber/{distinct_id}/channel_preference","tags":["communication"],"parameters":[{"name":"distinct_id","in":"query","required":true,"description":"distinct_id of the user whose preferences should be fetched","schema":{"type":"string","description":"distinct_id of the user whose preferences should be fetched"}},{"name":"tenant_id","in":"query","required":false,"description":"to fetch user preferences for a particular brand","schema":{"type":"string","description":"to fetch user preferences for a particular brand"}}],"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/communication:suprsend/preference-update-channel-preferences":{"post":{"operationId":"communication_suprsend_preference_update_channel_preferences","summary":"Update User Preferences (Channel level)","description":"POST /v1/subscriber/{distinct_id}/channel_preference","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["distinct_id"],"properties":{"distinct_id":{"type":"string","description":"distinct_id of the user whose preferences should be fetched"},"tenant_id":{"type":"string","description":"to fetch user preferences for a particular brand"},"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/communication:suprsend/pref-category-get-user-preferences-all-categories":{"get":{"operationId":"communication_suprsend_pref_category_get_user_preferences_all_categories","summary":"Get User Preferences (All Categories)","description":"GET /v1/subscriber/{distinct_id}/category","tags":["communication"],"parameters":[{"name":"distinct_id","in":"query","required":true,"description":"distinct_id of the user whose preferences should be fetched","schema":{"type":"string","description":"distinct_id of the user whose preferences should be fetched"}},{"name":"tenant_id","in":"query","required":false,"description":"to fetch user preferences for a particular brand","schema":{"type":"string","description":"to fetch user preferences for a particular brand"}}],"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/communication:suprsend/brand-update-default-preference":{"post":{"operationId":"communication_suprsend_brand_update_default_preference","summary":"Update Brand Default Preference","description":"POST /v1/brand/{brand_id}/category/{category_slug}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["brand_id","category_slug"],"properties":{"brand_id":{"type":"string","description":"unique identifier of the brand you want to update default preferences for"},"category_slug":{"type":"string","description":"notification category slug. You can get this from Notification Categories page on SuprSend dashboard -> Settings page"},"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/communication:suprsend/brand-get-categories":{"get":{"operationId":"communication_suprsend_brand_get_categories","summary":"Get Brand Default Preference","description":"GET /v1/brand/{brand_id}/category","tags":["communication"],"parameters":[{"name":"brand_id","in":"query","required":true,"description":"unique identifier of the brand you want to get default preferences for","schema":{"type":"string","description":"unique identifier of the brand you want to get default preferences for"}}],"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/communication:suprsend/subscriber-list-get-all-lists":{"get":{"operationId":"communication_suprsend_subscriber_list_get_all_lists","summary":"Get all Lists","description":"GET /v1/subscriber_list","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"number of results to be returned in API response","schema":{"type":"string","default":"20","description":"number of results to be returned in API response"}},{"name":"offset","in":"query","required":false,"description":"starting position of brand list","schema":{"type":"string","default":"0","description":"starting position of brand list"}}],"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/communication:suprsend/subscriber-list-create-list":{"post":{"operationId":"communication_suprsend_subscriber_list_create_list","summary":"Create a List","description":"POST /v1/subscriber_list","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"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/communication:suprsend/subscriber-list-get-list-data":{"get":{"operationId":"communication_suprsend_subscriber_list_get_list_data","summary":"Get List data","description":"GET /v1/subscriber_list/{list_id}","tags":["communication"],"parameters":[{"name":"list_id","in":"query","required":true,"description":"Unique string idenitifier of the list.","schema":{"type":"string","default":"_list_id_","description":"Unique string idenitifier of the list."}}],"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"}}},"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"}}}}}}}