{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://zieapi.vercel.app"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:customer-io-journeys-app/send-messages-trigger-broadcast":{"post":{"operationId":"communication_customer_io_journeys_app_send_messages_trigger_broadcast","summary":"Trigger a broadcast","description":"POST /v1/campaigns/{broadcast_id}/triggers","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcast_id"],"properties":{"broadcast_id":{"type":"integer","description":"The ID of the broadcast that you want to trigger."},"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:customer-io-journeys-app/broadcasts-get-broadcast-errors":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_broadcast_errors","summary":"Get broadcast error descriptions","description":"GET /v1/campaigns/{broadcast_id}/triggers/{trigger_id}/errors","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The ID of the broadcast that you want to return information about.","schema":{"type":"integer","description":"The ID of the broadcast that you want to return information about."}},{"name":"trigger_id","in":"query","required":true,"description":"The ID of the campaign trigger that you want to return information for.","schema":{"type":"integer","description":"The ID of the campaign trigger that you want to return information for."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}}],"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:customer-io-journeys-app/send-messages-transactional-email":{"post":{"operationId":"communication_customer_io_journeys_app_send_messages_transactional_email","summary":"Send a transactional email","description":"POST /v1/send/email","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:customer-io-journeys-app/send-messages-transactional-push":{"post":{"operationId":"communication_customer_io_journeys_app_send_messages_transactional_push","summary":"Send a transactional push","description":"POST /v1/send/push","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:customer-io-journeys-app/activities-list":{"get":{"operationId":"communication_customer_io_journeys_app_activities_list","summary":"List activities","description":"GET /v1/activities","tags":["communication"],"parameters":[{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"type","in":"query","required":false,"description":"The type of activity you want to search for. Types with `_o: ` are for objects and types with `_r: ` are for relationships.","schema":{"type":"string","description":"The type of activity you want to search for. Types with `_o: ` are for objects and types with `_r: ` are for relationships."}},{"name":"name","in":"query","required":false,"description":"The name of the event or attribute you want to return.","schema":{"type":"string","description":"The name of the event or attribute you want to return."}},{"name":"deleted","in":"query","required":false,"description":"If true, return results for deleted people.","schema":{"type":"boolean","default":false,"description":"If true, return results for deleted people."}},{"name":"customer_id","in":"query","required":false,"description":"The `identifier` of the person you want to look up. By default, this is a person's `id`. You can use the `id_type` parameter to look up a…","schema":{"type":"string","description":"The `identifier` of the person you want to look up. By default, this is a person's `id`. You can use the `id_type` parameter to look up a…"}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":10,"description":"The maximum number of results you want to retrieve per page."}}],"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:customer-io-journeys-app/broadcasts-list":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_list","summary":"List broadcasts","description":"GET /v1/broadcasts","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/broadcasts-get-metadata":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_metadata","summary":"Get a broadcast","description":"GET /v1/broadcasts/{broadcast_id}","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}}],"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:customer-io-journeys-app/broadcasts-get-status":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_status","summary":"Get the status of a broadcast","description":"GET /v1/campaigns/{broadcast_id}/triggers/{trigger_id}","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The ID of the broadcast that you want to return information about.","schema":{"type":"integer","description":"The ID of the broadcast that you want to return information about."}},{"name":"trigger_id","in":"query","required":true,"description":"The ID of the campaign trigger that you want to return information for.","schema":{"type":"integer","description":"The ID of the campaign trigger that you want to return information 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:customer-io-journeys-app/broadcasts-get-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_metrics","summary":"Get broadcast metrics","description":"GET /v1/broadcasts/{broadcast_id}/metrics","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/broadcasts-get-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_link_metrics","summary":"Get broadcast link metrics","description":"GET /v1/broadcasts/{broadcast_id}/metrics/links","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"unique","in":"query","required":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…","schema":{"type":"boolean","default":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…"}}],"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:customer-io-journeys-app/broadcasts-get-actions":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_actions","summary":"List broadcast actions","description":"GET /v1/broadcasts/{broadcast_id}/actions","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}}],"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:customer-io-journeys-app/broadcasts-get-messages":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_messages","summary":"Get messages for a broadcast","description":"GET /v1/broadcasts/{broadcast_id}/messages","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}},{"name":"metric","in":"query","required":false,"description":"Determines the metric(s) you want to return.","schema":{"type":"string","enum":["attempted","sent","delivered","opened","clicked","converted","bounced","spammed","unsubscribed","dropped","failed","undeliverable"],"description":"Determines the metric(s) you want to return."}},{"name":"state","in":"query","required":false,"description":"The state of a broadcast.","schema":{"type":"string","enum":["failed","sent","drafted","attempted"],"description":"The state of a broadcast."}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/broadcasts-get-action-details":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_action_details","summary":"Get a broadcast action","description":"GET /v1/broadcasts/{broadcast_id}/actions/{action_id}","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}}],"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:customer-io-journeys-app/broadcasts-update-action-contents":{"post":{"operationId":"communication_customer_io_journeys_app_broadcasts_update_action_contents","summary":"Update a broadcast action","description":"PUT /v1/broadcasts/{broadcast_id}/actions/{action_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcast_id","action_id"],"properties":{"broadcast_id":{"type":"integer","description":"The identifier of a broadcast."},"action_id":{"type":"integer","description":"The action you want to lookup or act on."},"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:customer-io-journeys-app/broadcasts-get-translation-message":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_translation_message","summary":"Get a translation of a broadcast message","description":"GET /v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language}","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"language","in":"query","required":true,"description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"}}],"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:customer-io-journeys-app/broadcasts-update-translation":{"post":{"operationId":"communication_customer_io_journeys_app_broadcasts_update_translation","summary":"Update a translation of a broadcast message","description":"PUT /v1/broadcasts/{broadcast_id}/actions/{action_id}/language/{language}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["broadcast_id","action_id","language"],"properties":{"broadcast_id":{"type":"integer","description":"The identifier of a broadcast."},"action_id":{"type":"integer","description":"The action you want to lookup or act on."},"language":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"},"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:customer-io-journeys-app/broadcasts-get-action-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_action_metrics","summary":"Get broadcast action metrics","description":"GET /v1/broadcast/{broadcast_id}/actions/{action_id}/metrics","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/broadcasts-get-action-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_action_link_metrics","summary":"Get broadcast action link metrics","description":"GET /v1/broadcasts/{broadcast_id}/actions/{action_id}/metrics/links","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/broadcasts-get-triggers":{"get":{"operationId":"communication_customer_io_journeys_app_broadcasts_get_triggers","summary":"Get broadcast triggers","description":"GET /v1/broadcasts/{broadcast_id}/triggers","tags":["communication"],"parameters":[{"name":"broadcast_id","in":"query","required":true,"description":"The identifier of a broadcast.","schema":{"type":"integer","description":"The identifier of a broadcast."}}],"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:customer-io-journeys-app/campaigns-get-list":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_list","summary":"List campaigns","description":"GET /v1/campaigns","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/campaigns-get-metadata":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_metadata","summary":"Get a campaign","description":"GET /v1/campaigns/{campaign_id}","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}}],"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:customer-io-journeys-app/campaigns-get-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_metrics","summary":"Get campaign metrics","description":"GET /v1/campaigns/{campaign_id}/metrics","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/campaigns-get-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_link_metrics","summary":"Get campaign link metrics","description":"GET /v1/campaigns/{campaign_id}/metrics/links","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"unique","in":"query","required":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…","schema":{"type":"boolean","default":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…"}}],"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:customer-io-journeys-app/campaigns-list-actions":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_list_actions","summary":"List campaign actions","description":"GET /v1/campaigns/{campaign_id}/actions","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}}],"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:customer-io-journeys-app/campaigns-get-message-metadata":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_message_metadata","summary":"Get campaign message metadata","description":"GET /v1/campaigns/{campaign_id}/messages","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":50,"description":"The maximum number of results you want to retrieve per page."}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}},{"name":"metric","in":"query","required":false,"description":"Determines the metric(s) you want to return.","schema":{"type":"string","enum":["attempted","sent","delivered","opened","clicked","converted","bounced","spammed","unsubscribed","dropped","failed","undeliverable"],"description":"Determines the metric(s) you want to return."}},{"name":"drafts","in":"query","required":false,"description":"If true, your request returns drafts rather than active/sent messages.","schema":{"type":"boolean","description":"If true, your request returns drafts rather than active/sent messages."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/campaigns-get-action-info":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_action_info","summary":"Get a campaign action","description":"GET /v1/campaigns/{campaign_id}/actions/{action_id}","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}}],"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:customer-io-journeys-app/campaigns-update-action-contents":{"post":{"operationId":"communication_customer_io_journeys_app_campaigns_update_action_contents","summary":"Update a campaign action","description":"PUT /v1/campaigns/{campaign_id}/actions/{action_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","action_id"],"properties":{"campaign_id":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."},"action_id":{"type":"integer","description":"The action you want to lookup or act on."},"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:customer-io-journeys-app/campaigns-get-message-translation":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_message_translation","summary":"Get a translation of a campaign message","description":"GET /v1/campaigns/{campaign_id}/actions/{action_id}/language/{language}","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"language","in":"query","required":true,"description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"}}],"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:customer-io-journeys-app/campaigns-update-translation":{"post":{"operationId":"communication_customer_io_journeys_app_campaigns_update_translation","summary":"Update a translation of a campaign message","description":"PUT /v1/campaigns/{campaign_id}/actions/{action_id}/language/{language}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaign_id","action_id","language"],"properties":{"campaign_id":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."},"action_id":{"type":"integer","description":"The action you want to lookup or act on."},"language":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"},"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:customer-io-journeys-app/campaigns-get-action-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_action_metrics","summary":"Get campaign action metrics","description":"GET /v1/campaigns/{campaign_id}/actions/{action_id}/metrics","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/campaigns-get-link-metrics-for-action":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_link_metrics_for_action","summary":"Get link metrics for an action","description":"GET /v1/campaigns/{campaign_id}/actions/{action_id}/metrics/links","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"action_id","in":"query","required":true,"description":"The action you want to lookup or act on.","schema":{"type":"integer","description":"The action you want to lookup or act on."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/campaigns-get-journey-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_campaigns_get_journey_metrics","summary":"Get campaign journey metrics","description":"GET /v1/campaigns/{campaign_id}/journey_metrics","tags":["communication"],"parameters":[{"name":"campaign_id","in":"query","required":true,"description":"The ID of the campaign that you want to trigger or return information about.","schema":{"type":"integer","description":"The ID of the campaign that you want to trigger or return information about."}},{"name":"start","in":"query","required":true,"description":"The unix timestamp for the beginning of your journey metrics report.","schema":{"type":"integer","description":"The unix timestamp for the beginning of your journey metrics report."}},{"name":"end","in":"query","required":true,"description":"The unix timestamp for the end of your journey metrics report.","schema":{"type":"integer","description":"The unix timestamp for the end of your journey metrics report."}},{"name":"resolution","in":"query","required":true,"description":"Determines increment for journey metrics—hourly, daily, weekly, or monthly.","schema":{"type":"string","enum":["hours","hourly","days","daily","weeks","weekly","months","monthly"],"description":"Determines increment for journey metrics—hourly, daily, weekly, or monthly."}}],"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:customer-io-journeys-app/collections-list":{"get":{"operationId":"communication_customer_io_journeys_app_collections_list","summary":"List your collections","description":"GET /v1/collections","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/collections-create-new":{"post":{"operationId":"communication_customer_io_journeys_app_collections_create_new","summary":"Create a collection","description":"POST /v1/collections","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:customer-io-journeys-app/collections-get-details":{"get":{"operationId":"communication_customer_io_journeys_app_collections_get_details","summary":"Lookup a collection","description":"GET /v1/collections/{collection_id}","tags":["communication"],"parameters":[{"name":"collection_id","in":"query","required":true,"description":"The identifier for a collection.","schema":{"type":"integer","description":"The identifier for a collection."}}],"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:customer-io-journeys-app/collections-update-collection":{"post":{"operationId":"communication_customer_io_journeys_app_collections_update_collection","summary":"Update a collection","description":"PUT /v1/collections/{collection_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"integer","description":"The identifier for a collection."},"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:customer-io-journeys-app/collections-remove-collection":{"post":{"operationId":"communication_customer_io_journeys_app_collections_remove_collection","summary":"Delete a collection","description":"DELETE /v1/collections/{collection_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"integer","description":"The identifier for a collection."}}}}}},"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:customer-io-journeys-app/collections-get-contents":{"get":{"operationId":"communication_customer_io_journeys_app_collections_get_contents","summary":"Lookup collection contents","description":"GET /v1/collections/{collection_id}/content","tags":["communication"],"parameters":[{"name":"collection_id","in":"query","required":true,"description":"The identifier for a collection.","schema":{"type":"integer","description":"The identifier for a collection."}}],"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:customer-io-journeys-app/collections-update-contents":{"post":{"operationId":"communication_customer_io_journeys_app_collections_update_contents","summary":"Update the contents of a collection","description":"PUT /v1/collections/{collection_id}/content","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["collection_id"],"properties":{"collection_id":{"type":"integer","description":"The identifier for a collection."},"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:customer-io-journeys-app/customers-find-by-email":{"get":{"operationId":"communication_customer_io_journeys_app_customers_find_by_email","summary":"Get customers by email","description":"GET /v1/customers","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"The email address you want to search for.","schema":{"type":"string","description":"The email address you want to search 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:customer-io-journeys-app/customers-search-filter":{"post":{"operationId":"communication_customer_io_journeys_app_customers_search_filter","summary":"Search for customers","description":"POST /v1/customers","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"},"limit":{"type":"integer","default":50,"description":"The maximum number of results you want to retrieve per 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:customer-io-journeys-app/customers-get-attributes":{"get":{"operationId":"communication_customer_io_journeys_app_customers_get_attributes","summary":"Lookup a customer's attributes","description":"GET /v1/customers/{customer_id}/attributes","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}}],"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:customer-io-journeys-app/customers-lookup-relationships":{"get":{"operationId":"communication_customer_io_journeys_app_customers_lookup_relationships","summary":"Lookup a customer's relationships","description":"GET /v1/customers/{customer_id}/relationships","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}}],"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:customer-io-journeys-app/customers-list-attributes-devices":{"post":{"operationId":"communication_customer_io_journeys_app_customers_list_attributes_devices","summary":"List customers, attributes, and devices","description":"POST /v1/customers/attributes","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:customer-io-journeys-app/customers-lookup-segments":{"get":{"operationId":"communication_customer_io_journeys_app_customers_lookup_segments","summary":"Lookup a customer's segments","description":"GET /v1/customers/{customer_id}/segments","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}}],"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:customer-io-journeys-app/customers-get-messages":{"get":{"operationId":"communication_customer_io_journeys_app_customers_get_messages","summary":"Lookup messages sent to a customer","description":"GET /v1/customers/{customer_id}/messages","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":50,"description":"The maximum number of results you want to retrieve per page."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/customers-get-activities":{"get":{"operationId":"communication_customer_io_journeys_app_customers_get_activities","summary":"Lookup a customer's activities","description":"GET /v1/customers/{customer_id}/activities","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":10,"description":"The maximum number of results you want to retrieve per page."}},{"name":"type","in":"query","required":false,"description":"The type of activity you want to search for. Types with `_o: ` are for objects and types with `_r: ` are for relationships.","schema":{"type":"string","description":"The type of activity you want to search for. Types with `_o: ` are for objects and types with `_r: ` are for relationships."}},{"name":"name","in":"query","required":false,"description":"For `event` and `attribute_update` types, you can search by event or attribute name respectively.","schema":{"type":"string","description":"For `event` and `attribute_update` types, you can search by event or attribute name respectively."}}],"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:customer-io-journeys-app/customers-get-subscription-preferences":{"get":{"operationId":"communication_customer_io_journeys_app_customers_get_subscription_preferences","summary":"Lookup a customer's subscription preferences","description":"GET /v1/customers/{customer_id}/subscription_preferences","tags":["communication"],"parameters":[{"name":"customer_id","in":"query","required":true,"description":"The ID of the customer you want to perform an operation against.","schema":{"type":"string","description":"The ID of the customer you want to perform an operation against."}},{"name":"id_type","in":"query","required":false,"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…","schema":{"type":"string","enum":["id","email","cio_id"],"description":"The type of `customer_id` you want to use to reference a person. If you don't provide this parameter, we assume that the `customer_id` in…"}},{"name":"language","in":"query","required":false,"description":"A [language tag](https://customer.io/docs/api/app/) you want the content translated in. If none is provided, the content will be sent in…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) you want the content translated in. If none is provided, the content will be sent in…"}},{"name":"Accept-Language","in":"query","required":false,"description":"The [language tag](https://customer.io/docs/api/app/) you want the content translated in. If none is provided, the content will be sent in…","schema":{"type":"string","description":"The [language tag](https://customer.io/docs/api/app/) you want the content translated in. If none is provided, the content will be sent in…"}}],"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:customer-io-journeys-app/esp-suppression-lookup-address":{"get":{"operationId":"communication_customer_io_journeys_app_esp_suppression_lookup_address","summary":"Look up an ESP-suppressed address","description":"GET /v1/esp/search_suppression/{email_address}","tags":["communication"],"parameters":[{"name":"email_address","in":"query","required":true,"description":"The email address of the person you want to look up.","schema":{"type":"string","description":"The email address of the person you want to look up."}}],"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:customer-io-journeys-app/esp-suppression-get-emails-by-type":{"get":{"operationId":"communication_customer_io_journeys_app_esp_suppression_get_emails_by_type","summary":"Get ESP-suppressed emails by type","description":"GET /v1/esp/suppression/{suppression_type}","tags":["communication"],"parameters":[{"name":"suppression_type","in":"query","required":true,"description":"The reason a person's email address was suppressed by the email service provider (ESP).","schema":{"type":"string","enum":["bounces","blocks","spam_reports","invalid_emails"],"description":"The reason a person's email address was suppressed by the email service provider (ESP)."}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":100,"description":"The maximum number of results you want to retrieve per page."}},{"name":"offset","in":"query","required":false,"description":"The number of records to skip before retrieving results.","schema":{"type":"integer","default":0,"description":"The number of records to skip before retrieving results."}}],"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:customer-io-journeys-app/esp-suppression-email-address":{"post":{"operationId":"communication_customer_io_journeys_app_esp_suppression_email_address","summary":"Suppress an email at the ESP","description":"POST /v1/esp/suppression/{suppression_type}/{email_address}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suppression_type","email_address"],"properties":{"suppression_type":{"type":"string","enum":["bounces","blocks","spam_reports","invalid_emails"],"description":"The reason a person's email address was suppressed by the email service provider (ESP)."},"email_address":{"type":"string","description":"The email address of the person you want to look up."}}}}}},"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:customer-io-journeys-app/esp-suppression-un-suppress-address":{"post":{"operationId":"communication_customer_io_journeys_app_esp_suppression_un_suppress_address","summary":"Un-suppress an ESP-suppressed address","description":"DELETE /v1/esp/suppression/{suppression_type}/{email_address}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["suppression_type","email_address"],"properties":{"suppression_type":{"type":"string","enum":["bounces","blocks","spam_reports","invalid_emails"],"description":"The reason a person's email address was suppressed by the email service provider (ESP)."},"email_address":{"type":"string","description":"The email address of the person you want to look up."}}}}}},"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:customer-io-journeys-app/exports-list-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_exports_list_metrics","summary":"List exports","description":"GET /v1/exports","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/exports-get-export-info":{"get":{"operationId":"communication_customer_io_journeys_app_exports_get_export_info","summary":"Get an export","description":"GET /v1/exports/{export_id}","tags":["communication"],"parameters":[{"name":"export_id","in":"query","required":true,"description":"The export_id you want to access.","schema":{"type":"integer","description":"The export_id you want to access."}}],"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:customer-io-journeys-app/exports-download-export-signed-link":{"get":{"operationId":"communication_customer_io_journeys_app_exports_download_export_signed_link","summary":"Download an export","description":"GET /v1/exports/{export_id}/download","tags":["communication"],"parameters":[{"name":"export_id","in":"query","required":true,"description":"The export_id you want to access.","schema":{"type":"integer","description":"The export_id you want to access."}}],"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:customer-io-journeys-app/exports-create-customer-export":{"post":{"operationId":"communication_customer_io_journeys_app_exports_create_customer_export","summary":"Export customer data","description":"POST /v1/exports/customers","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:customer-io-journeys-app/exports-export-deliveries-info":{"post":{"operationId":"communication_customer_io_journeys_app_exports_export_deliveries_info","summary":"Export information about deliveries","description":"POST /v1/exports/deliveries","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:customer-io-journeys-app/imports-bulk-upload-csv":{"post":{"operationId":"communication_customer_io_journeys_app_imports_bulk_upload_csv","summary":"Import items in bulk","description":"POST /v1/imports","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:customer-io-journeys-app/imports-get-bulk-import":{"get":{"operationId":"communication_customer_io_journeys_app_imports_get_bulk_import","summary":"Retrieve a bulk import","description":"GET /v1/imports/{import_id}","tags":["communication"],"parameters":[{"name":"import_id","in":"query","required":true,"description":"The `id` of the import you want to lookup. This value is [returned from a successful import](https://customer.io/docs/api/app/).","schema":{"type":"integer","description":"The `id` of the import you want to lookup. This value is [returned from a successful import](https://customer.io/docs/api/app/)."}}],"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:customer-io-journeys-app/info-list-ip-addresses":{"get":{"operationId":"communication_customer_io_journeys_app_info_list_ip_addresses","summary":"List IP addresses","description":"GET /v1/info/ip_addresses","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/messages-list-deliveries":{"get":{"operationId":"communication_customer_io_journeys_app_messages_list_deliveries","summary":"List messages","description":"GET /v1/messages","tags":["communication"],"parameters":[{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":50,"description":"The maximum number of results you want to retrieve per page."}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}},{"name":"metric","in":"query","required":false,"description":"Determines the metric(s) you want to return.","schema":{"type":"string","enum":["attempted","sent","delivered","opened","clicked","converted","bounced","spammed","unsubscribed","dropped","failed","undeliverable"],"description":"Determines the metric(s) you want to return."}},{"name":"drafts","in":"query","required":false,"description":"If true, your request returns drafts rather than active/sent messages.","schema":{"type":"boolean","description":"If true, your request returns drafts rather than active/sent messages."}},{"name":"campaign_id","in":"query","required":false,"description":"The campaign you want to filter for.","schema":{"type":"integer","description":"The campaign you want to filter for."}},{"name":"newsletter_id","in":"query","required":false,"description":"The newsletter you want to filter for.","schema":{"type":"integer","description":"The newsletter you want to filter for."}},{"name":"action_id","in":"query","required":false,"description":"The action you want to filter for.","schema":{"type":"integer","description":"The action you want to filter for."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/messages-get-message-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_messages_get_message_metrics","summary":"Get a message","description":"GET /v1/messages/{message_id}","tags":["communication"],"parameters":[{"name":"message_id","in":"query","required":true,"description":"The identifier of a message.","schema":{"type":"string","description":"The identifier of a message."}}],"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:customer-io-journeys-app/messages-get-archived-message":{"get":{"operationId":"communication_customer_io_journeys_app_messages_get_archived_message","summary":"Get an archived message","description":"GET /v1/messages/{message_id}/archived_message","tags":["communication"],"parameters":[{"name":"message_id","in":"query","required":true,"description":"The identifier of a message.","schema":{"type":"string","description":"The identifier of a message."}}],"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:customer-io-journeys-app/newsletters-list-newsletters":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_list_newsletters","summary":"List newsletters","description":"GET /v1/newsletters","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/newsletters-get-metadata":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_metadata","summary":"Get a newsletter","description":"GET /v1/newsletters/{newsletter_id}","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}}],"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:customer-io-journeys-app/newsletters-get-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_metrics","summary":"Get newsletter metrics","description":"GET /v1/newsletters/{newsletter_id}/metrics","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/newsletters-get-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_link_metrics","summary":"Get newsletter link metrics","description":"GET /v1/newsletters/{newsletter_id}/metrics/links","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"unique","in":"query","required":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…","schema":{"type":"boolean","default":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…"}}],"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:customer-io-journeys-app/newsletters-list-variants":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_list_variants","summary":"List newsletter variants","description":"GET /v1/newsletters/{newsletter_id}/contents","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}}],"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:customer-io-journeys-app/newsletters-get-message-metadata":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_message_metadata","summary":"Get newsletter message metadata","description":"GET /v1/newsletters/{newsletter_id}/messages","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}},{"name":"metric","in":"query","required":false,"description":"Determines the metric(s) you want to return.","schema":{"type":"string","enum":["attempted","sent","delivered","opened","clicked","converted","bounced","spammed","unsubscribed","dropped","failed","undeliverable"],"description":"Determines the metric(s) you want to return."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/newsletters-get-variant-info":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_variant_info","summary":"Get a newsletter variant","description":"GET /v1/newsletters/{newsletter_id}/contents/{content_id}","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"content_id","in":"query","required":true,"description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…","schema":{"type":"integer","description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…"}}],"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:customer-io-journeys-app/newsletters-update-variant-contents":{"post":{"operationId":"communication_customer_io_journeys_app_newsletters_update_variant_contents","summary":"Update a newsletter variant","description":"PUT /v1/newsletters/{newsletter_id}/contents/{content_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["newsletter_id","content_id"],"properties":{"newsletter_id":{"type":"integer","description":"The identifier of a newsletter."},"content_id":{"type":"integer","description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…"},"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:customer-io-journeys-app/newsletters-get-translation":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_translation","summary":"Get a translation of a newsletter variant","description":"GET /v1/newsletters/{newsletter_id}/language/{language}","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"language","in":"query","required":true,"description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"}}],"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:customer-io-journeys-app/newsletters-update-translation":{"post":{"operationId":"communication_customer_io_journeys_app_newsletters_update_translation","summary":"Update a translation of a newsletter variant","description":"PUT /v1/newsletters/{newsletter_id}/language/{language}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["newsletter_id","language"],"properties":{"newsletter_id":{"type":"integer","description":"The identifier of a newsletter."},"language":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"},"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:customer-io-journeys-app/newsletters-list-test-groups":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_list_test_groups","summary":"List A/B test groups in a newsletter","description":"GET /v1/newsletters/{newsletter_id}/test_groups","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}}],"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:customer-io-journeys-app/newsletters-get-translation-info":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_translation_info","summary":"Get a translation in a newsletter test group","description":"GET /v1/newsletters/{newsletter_id}/test_group/{test_group_id}/language/{language}","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"test_group_id","in":"query","required":true,"description":"The ID of the A/B test group.","schema":{"type":"string","description":"The ID of the A/B test group."}},{"name":"language","in":"query","required":true,"description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"}}],"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:customer-io-journeys-app/newsletters-update-translation-2":{"post":{"operationId":"communication_customer_io_journeys_app_newsletters_update_translation_2","summary":"Update a translation in a newsletter test group","description":"PUT /v1/newsletters/{newsletter_id}/test_group/{test_group_id}/language/{language}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["newsletter_id","test_group_id","language"],"properties":{"newsletter_id":{"type":"integer","description":"The identifier of a newsletter."},"test_group_id":{"type":"string","description":"The ID of the A/B test group."},"language":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"},"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:customer-io-journeys-app/newsletters-get-variant-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_variant_metrics","summary":"Get metrics for a variant","description":"GET /v1/newsletters/{newsletter_id}/contents/{content_id}/metrics","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"content_id","in":"query","required":true,"description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…","schema":{"type":"integer","description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…"}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/newsletters-get-newsletter-variant-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_newsletters_get_newsletter_variant_link_metrics","summary":"Get newsletter variant link metrics","description":"GET /v1/newsletters/{newsletter_id}/contents/{content_id}/metrics/links","tags":["communication"],"parameters":[{"name":"newsletter_id","in":"query","required":true,"description":"The identifier of a newsletter.","schema":{"type":"integer","description":"The identifier of a newsletter."}},{"name":"content_id","in":"query","required":true,"description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…","schema":{"type":"integer","description":"The identifier of a newsletter variant—a language in a multi-language message or an individual test in an A/B test. You can [list your…"}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"type","in":"query","required":false,"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.","schema":{"type":"string","enum":["email","webhook","twilio","slack","push","in_app"],"description":"The type of item you want to return metrics for. When empty, the response contains metrics for all possible types."}}],"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:customer-io-journeys-app/objects-get-all-object-types":{"get":{"operationId":"communication_customer_io_journeys_app_objects_get_all_object_types","summary":"List object types","description":"GET /v1/object_types","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/objects-find-objects-filter":{"post":{"operationId":"communication_customer_io_journeys_app_objects_find_objects_filter","summary":"Find objects","description":"POST /v1/objects","tags":["communication"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"start":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"},"limit":{"type":"integer","description":"The maximum number of results you want to retrieve per 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:customer-io-journeys-app/objects-get-object-relationships":{"get":{"operationId":"communication_customer_io_journeys_app_objects_get_object_relationships","summary":"Get Object Relationships","description":"GET /v1/objects/{object_type_id}/{object_id}/relationships","tags":["communication"],"parameters":[{"name":"object_type_id","in":"query","required":true,"description":"The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type.","schema":{"type":"integer","description":"The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type."}},{"name":"object_id","in":"query","required":true,"description":"The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`.","schema":{"type":"string","description":"The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`."}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}},{"name":"id_type","in":"query","required":false,"schema":{"type":"string","enum":["object_id","cio_object_id"],"default":"object_id"}}],"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:customer-io-journeys-app/objects-get-attributes":{"get":{"operationId":"communication_customer_io_journeys_app_objects_get_attributes","summary":"Get Object Attributes","description":"GET /v1/objects/{object_type_id}/{object_id}/attributes","tags":["communication"],"parameters":[{"name":"object_type_id","in":"query","required":true,"description":"The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type.","schema":{"type":"integer","description":"The object type an object belongs to—like \"Companies\" or \"Accounts\". Object type IDs begin at `1` and increment for each new type."}},{"name":"object_id","in":"query","required":true,"description":"The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`.","schema":{"type":"string","description":"The `object_id` or `cio_object_id` of an object, depending on the `id_type` specified in query params. `id_type` defaults to `object_id`."}},{"name":"id_type","in":"query","required":false,"schema":{"type":"string","enum":["object_id","cio_object_id"],"default":"object_id"}}],"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:customer-io-journeys-app/reporting-webhooks-list-reporting-webhooks":{"get":{"operationId":"communication_customer_io_journeys_app_reporting_webhooks_list_reporting_webhooks","summary":"List reporting webhooks","description":"GET /v1/reporting_webhooks","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/reporting-webhooks-create-webhook-config":{"post":{"operationId":"communication_customer_io_journeys_app_reporting_webhooks_create_webhook_config","summary":"Create a reporting webhook","description":"POST /v1/reporting_webhooks","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:customer-io-journeys-app/reporting-webhooks-get-webhook-info":{"get":{"operationId":"communication_customer_io_journeys_app_reporting_webhooks_get_webhook_info","summary":"Get a reporting webhook","description":"GET /v1/reporting_webhooks/{webhook_id}","tags":["communication"],"parameters":[{"name":"webhook_id","in":"query","required":true,"description":"The identifier of a webhook.","schema":{"type":"integer","description":"The identifier of a webhook."}}],"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:customer-io-journeys-app/reporting-webhooks-update-configuration":{"post":{"operationId":"communication_customer_io_journeys_app_reporting_webhooks_update_configuration","summary":"Update a webhook configuration","description":"PUT /v1/reporting_webhooks/{webhook_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id"],"properties":{"webhook_id":{"type":"integer","description":"The identifier of a webhook."},"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:customer-io-journeys-app/reporting-webhooks-delete-webhook-configuration":{"post":{"operationId":"communication_customer_io_journeys_app_reporting_webhooks_delete_webhook_configuration","summary":"Delete a reporting webhook","description":"DELETE /v1/reporting_webhooks/{webhook_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id"],"properties":{"webhook_id":{"type":"integer","description":"The identifier of a webhook."}}}}}},"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:customer-io-journeys-app/segments-list":{"get":{"operationId":"communication_customer_io_journeys_app_segments_list","summary":"List segments","description":"GET /v1/segments","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/segments-create-manual-segment":{"post":{"operationId":"communication_customer_io_journeys_app_segments_create_manual_segment","summary":"Create a manual segment","description":"POST /v1/segments","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:customer-io-journeys-app/segments-get-segment-info":{"get":{"operationId":"communication_customer_io_journeys_app_segments_get_segment_info","summary":"Get a segment","description":"GET /v1/segments/{segment_id}","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…","schema":{"type":"integer","description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…"}}],"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:customer-io-journeys-app/segments-delete-manual-segment":{"post":{"operationId":"communication_customer_io_journeys_app_segments_delete_manual_segment","summary":"Delete a segment","description":"DELETE /v1/segments/{segment_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["segment_id"],"properties":{"segment_id":{"type":"integer","description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…"}}}}}},"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:customer-io-journeys-app/segments-get-dependencies":{"get":{"operationId":"communication_customer_io_journeys_app_segments_get_dependencies","summary":"Get a segment's dependencies","description":"GET /v1/segments/{segment_id}/used_by","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…","schema":{"type":"integer","description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…"}}],"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:customer-io-journeys-app/segments-get-customer-count":{"get":{"operationId":"communication_customer_io_journeys_app_segments_get_customer_count","summary":"Get a segment customer count","description":"GET /v1/segments/{segment_id}/customer_count","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…","schema":{"type":"integer","description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…"}}],"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:customer-io-journeys-app/segments-list-membership":{"get":{"operationId":"communication_customer_io_journeys_app_segments_list_membership","summary":"List customers in a segment","description":"GET /v1/segments/{segment_id}/membership","tags":["communication"],"parameters":[{"name":"segment_id","in":"query","required":true,"description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…","schema":{"type":"integer","description":"The identifier for a segment. You can find your segment's ID on its page in the dashboard—go to *Segments*, select your segment, and find…"}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","default":1000,"description":"The maximum number of results you want to retrieve per page."}}],"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:customer-io-journeys-app/sender-identities-list":{"get":{"operationId":"communication_customer_io_journeys_app_sender_identities_list","summary":"List sender identities","description":"GET /v1/sender_identities","tags":["communication"],"parameters":[{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}},{"name":"sort","in":"query","required":false,"description":"Determine how you want to sort results, `asc` for chronological order and `desc` for reverse chronological order.","schema":{"type":"string","enum":["asc","desc"],"description":"Determine how you want to sort results, `asc` for chronological order and `desc` for reverse chronological order."}}],"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:customer-io-journeys-app/sender-identities-get-sender-info":{"get":{"operationId":"communication_customer_io_journeys_app_sender_identities_get_sender_info","summary":"Get a sender","description":"GET /v1/sender_identities/{sender_id}","tags":["communication"],"parameters":[{"name":"sender_id","in":"query","required":true,"description":"The identifier of a sender.","schema":{"type":"integer","description":"The identifier of a sender."}}],"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:customer-io-journeys-app/sender-identities-get-usage-data":{"get":{"operationId":"communication_customer_io_journeys_app_sender_identities_get_usage_data","summary":"Get sender usage data","description":"GET /v1/sender_identities/{sender_id}/used_by","tags":["communication"],"parameters":[{"name":"sender_id","in":"query","required":true,"description":"The identifier of a sender.","schema":{"type":"integer","description":"The identifier of a sender."}}],"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:customer-io-journeys-app/snippets-list":{"get":{"operationId":"communication_customer_io_journeys_app_snippets_list","summary":"List snippets","description":"GET /v1/snippets","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/snippets-create-or-update":{"post":{"operationId":"communication_customer_io_journeys_app_snippets_create_or_update","summary":"Create or update snippets","description":"PUT /v1/snippets","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:customer-io-journeys-app/snippets-remove-snippet":{"post":{"operationId":"communication_customer_io_journeys_app_snippets_remove_snippet","summary":"Delete a snippet","description":"DELETE /v1/snippets/{snippet_name}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["snippet_name"],"properties":{"snippet_name":{"type":"string","description":"The name of a snippet."}}}}}},"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:customer-io-journeys-app/subscription-center-list-topics":{"get":{"operationId":"communication_customer_io_journeys_app_subscription_center_list_topics","summary":"List subscription topics","description":"GET /v1/subscription_topics","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/transactional-list-messages":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_list_messages","summary":"List transactional messages","description":"GET /v1/transactional","tags":["communication"],"parameters":[],"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:customer-io-journeys-app/transactional-get-message-info":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_get_message_info","summary":"Get a transactional message","description":"GET /v1/transactional/{transactional_id}","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}}],"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:customer-io-journeys-app/transactional-list-content-variants":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_list_content_variants","summary":"List all variants of a transactional message","description":"GET /v1/transactional/{transactional_id}/contents","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}}],"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:customer-io-journeys-app/transactional-update-message-content":{"post":{"operationId":"communication_customer_io_journeys_app_transactional_update_message_content","summary":"Update a transactional message","description":"PUT /v1/transactional/{transactional_id}/content/{content_id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transactional_id","content_id"],"properties":{"transactional_id":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"},"content_id":{"type":"integer","description":"The content variant of your transactional message. You'll find the id in the URL of your transactional message. For example, if this is…"},"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:customer-io-journeys-app/transactional-get-message-translation":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_get_message_translation","summary":"Get a translation of a transactional message","description":"GET /v1/transactional/{transactional_id}/language/{language}","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}},{"name":"language","in":"query","required":true,"description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…","schema":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"}}],"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:customer-io-journeys-app/transactional-update-translation":{"post":{"operationId":"communication_customer_io_journeys_app_transactional_update_translation","summary":"Update a translation of a transactional message","description":"PUT /v1/transactional/{transactional_id}/language/{language}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["transactional_id","language"],"properties":{"transactional_id":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"},"language":{"type":"string","description":"A [language tag](https://customer.io/docs/api/app/) of a language variant. If you don't provide a language, we target your default…"},"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:customer-io-journeys-app/transactional-get-message-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_get_message_metrics","summary":"Get transactional message metrics","description":"GET /v1/transactional/{transactional_id}/metrics","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}}],"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:customer-io-journeys-app/transactional-get-message-link-metrics":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_get_message_link_metrics","summary":"Get transactional message link metrics","description":"GET /v1/transactional/{transactional_id}/metrics/links","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}},{"name":"period","in":"query","required":false,"description":"The unit of time for your report.","schema":{"type":"string","enum":["hours","days","weeks","months"],"default":"days","description":"The unit of time for your report."}},{"name":"steps","in":"query","required":false,"description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…","schema":{"type":"integer","description":"The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours,…"}},{"name":"unique","in":"query","required":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…","schema":{"type":"boolean","default":false,"description":"If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the…"}}],"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:customer-io-journeys-app/transactional-get-message-deliveries":{"get":{"operationId":"communication_customer_io_journeys_app_transactional_get_message_deliveries","summary":"Get transactional message deliveries","description":"GET /v1/transactional/{transactional_id}/messages","tags":["communication"],"parameters":[{"name":"transactional_id","in":"query","required":true,"description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…","schema":{"type":"integer","description":"The identifier of your transactional message. You'll find this in the UI or URL of your transactional message. For example, if this is the…"}},{"name":"start","in":"query","required":false,"description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…","schema":{"type":"string","description":"The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to…"}},{"name":"limit","in":"query","required":false,"description":"The maximum number of results you want to retrieve per page.","schema":{"type":"integer","description":"The maximum number of results you want to retrieve per page."}},{"name":"metric","in":"query","required":false,"description":"Determines the metric(s) you want to return.","schema":{"type":"string","enum":["attempted","sent","delivered","opened","clicked","converted","bounced","spammed","unsubscribed","dropped","failed","undeliverable"],"description":"Determines the metric(s) you want to return."}},{"name":"state","in":"query","required":false,"description":"The state of a broadcast.","schema":{"type":"string","enum":["failed","sent","drafted","attempted"],"description":"The state of a broadcast."}},{"name":"start_ts","in":"query","required":false,"description":"The beginning timestamp for your query.","schema":{"type":"integer","description":"The beginning timestamp for your query."}},{"name":"end_ts","in":"query","required":false,"description":"The ending timestamp for your query.","schema":{"type":"integer","description":"The ending timestamp for your query."}}],"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:customer-io-journeys-app/workspaces-list-workspaces":{"get":{"operationId":"communication_customer_io_journeys_app_workspaces_list_workspaces","summary":"List workspaces","description":"GET /v1/workspaces","tags":["communication"],"parameters":[],"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"}}}}}}}