{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/communication:brevo/email-campaigns-get-all":{"get":{"operationId":"communication_brevo_email_campaigns_get_all","summary":"Return all your created email campaigns","description":"GET /emailCampaigns","tags":["communication"],"parameters":[{"name":"type","in":"query","required":false,"description":"Filter on the type of the campaigns","schema":{"type":"string","enum":["classic","trigger"],"description":"Filter on the type of the campaigns"}},{"name":"status","in":"query","required":false,"description":"Filter on the status of the campaign","schema":{"type":"string","enum":["suspended","archive","sent","queued","draft","inProcess"],"description":"Filter on the status of the campaign"}},{"name":"statistics","in":"query","required":false,"description":"Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned…","schema":{"type":"string","enum":["globalStats","linksStats","statsByDomain"],"description":"Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned…"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.…","schema":{"type":"string","description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.…","schema":{"type":"string","description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent email campaigns.…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"excludeHtmlContent","in":"query","required":false,"description":"Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in the…","schema":{"type":"boolean","enum":[true,false],"description":"Use this flag to exclude htmlContent from the response body. If set to **true**, htmlContent field will be returned as empty string in 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:brevo/email-campaigns-create-campaign":{"post":{"operationId":"communication_brevo_email_campaigns_create_campaign","summary":"Create an email campaign","description":"POST /emailCampaigns","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/email-campaigns-get-report":{"get":{"operationId":"communication_brevo_email_campaigns_get_report","summary":"Get an email campaign report","description":"GET /emailCampaigns/{campaignId}","tags":["communication"],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"Id of the campaign","schema":{"type":"integer","description":"Id of the campaign"}},{"name":"statistics","in":"query","required":false,"description":"Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned…","schema":{"type":"string","enum":["globalStats","linksStats","statsByDomain","statsByDevice","statsByBrowser"],"description":"Filter on the type of statistics required. Example **globalStats** value will only fetch globalStats info of the campaign in returned…"}}],"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:brevo/email-campaigns-update-campaign":{"post":{"operationId":"communication_brevo_email_campaigns_update_campaign","summary":"Update an email campaign","description":"PUT /emailCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"},"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:brevo/email-campaigns-remove-campaign":{"post":{"operationId":"communication_brevo_email_campaigns_remove_campaign","summary":"Delete an email campaign","description":"DELETE /emailCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"}}}}}},"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:brevo/email-campaigns-send-immediate":{"post":{"operationId":"communication_brevo_email_campaigns_send_immediate","summary":"Send an email campaign immediately, based on campaignId","description":"POST /emailCampaigns/{campaignId}/sendNow","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"}}}}}},"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:brevo/email-campaigns-send-test-to-test-list":{"post":{"operationId":"communication_brevo_email_campaigns_send_test_to_test_list","summary":"Send an email campaign to your test list","description":"POST /emailCampaigns/{campaignId}/sendTest","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"},"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:brevo/email-campaigns-update-status":{"post":{"operationId":"communication_brevo_email_campaigns_update_status","summary":"Update an email campaign status","description":"PUT /emailCampaigns/{campaignId}/status","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"},"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:brevo/email-campaigns-send-report":{"post":{"operationId":"communication_brevo_email_campaigns_send_report","summary":"Send the report of a campaign","description":"POST /emailCampaigns/{campaignId}/sendReport","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"},"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:brevo/email-campaigns-get-ab-test-result":{"get":{"operationId":"communication_brevo_email_campaigns_get_ab_test_result","summary":"Get an A/B test email campaign results","description":"GET /emailCampaigns/{campaignId}/abTestCampaignResult","tags":["communication"],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"Id of the A/B test campaign","schema":{"type":"integer","description":"Id of the A/B test campaign"}}],"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:brevo/email-campaigns-get-shared-url":{"get":{"operationId":"communication_brevo_email_campaigns_get_shared_url","summary":"Get a shared template url","description":"GET /emailCampaigns/{campaignId}/sharedUrl","tags":["communication"],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"Id of the campaign or template","schema":{"type":"integer","description":"Id of the campaign or template"}}],"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:brevo/email-campaigns-export-recipients-post":{"post":{"operationId":"communication_brevo_email_campaigns_export_recipients_post","summary":"Export the recipients of an email campaign","description":"POST /emailCampaigns/{campaignId}/exportRecipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"Id of the campaign"},"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:brevo/email-campaigns-upload-image-to-gallery":{"post":{"operationId":"communication_brevo_email_campaigns_upload_image_to_gallery","summary":"Upload an image to your account's image gallery","description":"POST /emailCampaigns/images","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-send-transactional-email":{"post":{"operationId":"communication_brevo_transactional_emails_send_transactional_email","summary":"Send a transactional email","description":"POST /smtp/email","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-get-list":{"get":{"operationId":"communication_brevo_transactional_emails_get_list","summary":"Get the list of transactional emails on the basis of allowed filters","description":"GET /smtp/emails","tags":["communication"],"parameters":[{"name":"email","in":"query","required":false,"description":"**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent.","schema":{"type":"string","description":"**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent."}},{"name":"templateId","in":"query","required":false,"description":"**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email.","schema":{"type":"integer","description":"**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email."}},{"name":"messageId","in":"query","required":false,"description":"**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent.","schema":{"type":"string","description":"**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent."}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be…","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be…","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be…"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":500,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the 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:brevo/transactional-emails-get-content-by-uuid":{"get":{"operationId":"communication_brevo_transactional_emails_get_content_by_uuid","summary":"Get the personalized content of a sent transactional email","description":"GET /smtp/emails/{uuid}","tags":["communication"],"parameters":[{"name":"uuid","in":"query","required":true,"description":"Unique id of the transactional email that has been sent to a particular contact","schema":{"type":"string","description":"Unique id of the transactional email that has been sent to a particular contact"}}],"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:brevo/transactional-emails-delete-log":{"post":{"operationId":"communication_brevo_transactional_emails_delete_log","summary":"Delete an SMTP transactional log","description":"DELETE /smtp/log/{identifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"MessageId or Email of the transactional log(s) to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-list-templates":{"get":{"operationId":"communication_brevo_transactional_emails_list_templates","summary":"Get the list of email templates","description":"GET /smtp/templates","tags":["communication"],"parameters":[{"name":"templateStatus","in":"query","required":false,"description":"Filter on the status of the template. Active = true, inactive = false","schema":{"type":"boolean","description":"Filter on the status of the template. Active = true, inactive = false"}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":50,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/transactional-emails-create-template":{"post":{"operationId":"communication_brevo_transactional_emails_create_template","summary":"Create an email template","description":"POST /smtp/templates","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-get-template-info":{"get":{"operationId":"communication_brevo_transactional_emails_get_template_info","summary":"Returns the template information","description":"GET /smtp/templates/{templateId}","tags":["communication"],"parameters":[{"name":"templateId","in":"query","required":true,"description":"id of the template","schema":{"type":"integer","description":"id of the template"}}],"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:brevo/transactional-emails-update-template":{"post":{"operationId":"communication_brevo_transactional_emails_update_template","summary":"Update an email template","description":"PUT /smtp/templates/{templateId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId","body"],"properties":{"templateId":{"type":"integer","description":"id of the template"},"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:brevo/transactional-emails-delete-template-by-id":{"post":{"operationId":"communication_brevo_transactional_emails_delete_template_by_id","summary":"Delete an inactive email template","description":"DELETE /smtp/templates/{templateId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId"],"properties":{"templateId":{"type":"integer","description":"id of the template"}}}}}},"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:brevo/transactional-emails-send-test-template":{"post":{"operationId":"communication_brevo_transactional_emails_send_test_template","summary":"Send a template to your test list","description":"POST /smtp/templates/{templateId}/sendTest","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId","body"],"properties":{"templateId":{"type":"integer","description":"Id of the template"},"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:brevo/transactional-emails-get-aggregated-report":{"get":{"operationId":"communication_brevo_transactional_emails_get_aggregated_report","summary":"Get your transactional email activity aggregated over a period of time","description":"GET /smtp/statistics/aggregatedReport","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"}},{"name":"tag","in":"query","required":false,"description":"Tag of the emails","schema":{"type":"string","description":"Tag of the emails"}}],"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:brevo/transactional-emails-get-activity-per-day":{"get":{"operationId":"communication_brevo_transactional_emails_get_activity_per_day","summary":"Get your transactional email activity aggregated per day","description":"GET /smtp/statistics/reports","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":10,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page","schema":{"type":"integer","default":0,"description":"Index of the first document on the page"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD)","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD)"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD)","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD)"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"}},{"name":"tag","in":"query","required":false,"description":"Tag of the emails","schema":{"type":"string","description":"Tag of the emails"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/transactional-emails-get-all-activity":{"get":{"operationId":"communication_brevo_transactional_emails_get_all_activity","summary":"Get all your transactional email activity (unaggregated events)","description":"GET /smtp/statistics/events","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number limitation for the result returned","schema":{"type":"integer","default":2500,"description":"Number limitation for the result returned"}},{"name":"offset","in":"query","required":false,"description":"Beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Beginning point in the list to retrieve from."}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"}},{"name":"email","in":"query","required":false,"description":"Filter the report for a specific email addresses","schema":{"type":"string","description":"Filter the report for a specific email addresses"}},{"name":"event","in":"query","required":false,"description":"Filter the report for a specific event type","schema":{"type":"string","enum":["bounces","hardBounces","softBounces","delivered","spam","requests","opened","clicks","invalid","deferred","blocked","unsubscribed","error","loadedByProxy"],"description":"Filter the report for a specific event type"}},{"name":"tags","in":"query","required":false,"description":"Filter the report for tags (serialized and urlencoded array)","schema":{"type":"string","description":"Filter the report for tags (serialized and urlencoded array)"}},{"name":"messageId","in":"query","required":false,"description":"Filter on a specific message id","schema":{"type":"string","description":"Filter on a specific message id"}},{"name":"templateId","in":"query","required":false,"description":"Filter on a specific template id","schema":{"type":"integer","description":"Filter on a specific template id"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/transactional-emails-unblock-contact":{"post":{"operationId":"communication_brevo_transactional_emails_unblock_contact","summary":"Unblock or resubscribe a transactional contact","description":"DELETE /smtp/blockedContacts/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"contact email (urlencoded) to unblock."}}}}}},"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:brevo/transactional-emails-list-blocked-contacts":{"get":{"operationId":"communication_brevo_transactional_emails_list_blocked_contacts","summary":"Get the list of blocked or unsubscribed transactional contacts","description":"GET /smtp/blockedContacts","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the blocked or unsubscribed contacts"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the blocked or unsubscribed contacts"}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":50,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page","schema":{"type":"integer","default":0,"description":"Index of the first document on the page"}},{"name":"senders","in":"query","required":false,"description":"Comma separated list of emails of the senders from which contacts are blocked or unsubscribed","schema":{"type":"array","description":"Comma separated list of emails of the senders from which contacts are blocked or unsubscribed"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/transactional-emails-get-blocked-domains":{"get":{"operationId":"communication_brevo_transactional_emails_get_blocked_domains","summary":"Get the list of blocked domains","description":"GET /smtp/blockedDomains","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:brevo/transactional-emails-add-blocked-domain":{"post":{"operationId":"communication_brevo_transactional_emails_add_blocked_domain","summary":"Add a new domain to the list of blocked domains","description":"POST /smtp/blockedDomains","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-unblock-domain":{"post":{"operationId":"communication_brevo_transactional_emails_unblock_domain","summary":"Unblock an existing domain from the list of blocked domains","description":"DELETE /smtp/blockedDomains/{domain}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domain"],"properties":{"domain":{"type":"string","description":"The name of the domain to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-emails-remove-hardbounces":{"post":{"operationId":"communication_brevo_transactional_emails_remove_hardbounces","summary":"Delete hardbounces","description":"POST /smtp/deleteHardbounces","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:brevo/transactional-emails-get-email-status-by-id":{"get":{"operationId":"communication_brevo_transactional_emails_get_email_status_by_id","summary":"Fetch scheduled emails by batchId or messageId","description":"GET /smtp/emailStatus/{identifier}","tags":["communication"],"parameters":[{"name":"identifier","in":"query","required":true,"description":"The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email.","schema":{"type":"string","description":"The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email."}},{"name":"startDate","in":"query","required":false,"description":"Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current…","schema":{"type":"string","description":"Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older tha current…"},"example":"2022-02-02"},{"name":"endDate","in":"query","required":false,"description":"Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected…","schema":{"type":"string","description":"Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected…"},"example":"2022-03-02"},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid…","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid…"}},{"name":"status","in":"query","required":false,"description":"Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.","schema":{"type":"string","enum":["processed","inProgress","queued"],"description":"Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`."}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page. Not valid when identifier is `messageId`.","schema":{"type":"integer","default":100,"description":"Number of documents returned per page. Not valid when identifier is `messageId`."},"example":100},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page. Not valid when identifier is `messageId`.","schema":{"type":"integer","default":0,"description":"Index of the first document on the page. Not valid when identifier is `messageId`."},"example":0}],"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:brevo/transactional-emails-delete-scheduled-emails":{"post":{"operationId":"communication_brevo_transactional_emails_delete_scheduled_emails","summary":"Delete scheduled emails by batchId or messageId","description":"DELETE /smtp/email/{identifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email."}}}}}},"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:brevo/contacts-get-all-contacts":{"get":{"operationId":"communication_brevo_contacts_get_all_contacts","summary":"Get all the contacts","description":"GET /contacts","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"modifiedSince","in":"query","required":false,"description":"Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"createdSince","in":"query","required":false,"description":"Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the contacts created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"segmentId","in":"query","required":false,"description":"Id of the segment. **Either listIds or segmentId can be passed.**","schema":{"type":"integer","description":"Id of the segment. **Either listIds or segmentId can be passed.**"}},{"name":"listIds","in":"query","required":false,"description":"Ids of the list. **Either listIds or segmentId can be passed.**","schema":{"type":"array","description":"Ids of the list. **Either listIds or segmentId can be passed.**"}}],"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:brevo/contacts-create-new-contact":{"post":{"operationId":"communication_brevo_contacts_create_new_contact","summary":"Create a contact","description":"POST /contacts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-create-double-opt-in-contact":{"post":{"operationId":"communication_brevo_contacts_create_double_opt_in_contact","summary":"Create Contact via DOI (Double-Opt-In) Flow","description":"POST /contacts/doubleOptinConfirmation","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-get-details":{"get":{"operationId":"communication_brevo_contacts_get_details","summary":"Get a contact's details","description":"GET /contacts/{identifier}","tags":["communication"],"parameters":[{"name":"identifier","in":"query","required":true,"description":"Email (urlencoded) OR ID of the contact OR its SMS attribute value","schema":{"type":"string","description":"Email (urlencoded) OR ID of the contact OR its SMS attribute value"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to…","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to…","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal 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:brevo/contacts-update-contact-by-id":{"post":{"operationId":"communication_brevo_contacts_update_contact_by_id","summary":"Update a contact","description":"PUT /contacts/{identifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier","body"],"properties":{"identifier":{"type":"string","description":"Email (urlencoded) OR ID of the contact"},"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:brevo/contacts-delete-contact":{"post":{"operationId":"communication_brevo_contacts_delete_contact","summary":"Delete a contact","description":"DELETE /contacts/{identifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["identifier"],"properties":{"identifier":{"type":"string","description":"Email (urlencoded) OR ID of the contact"}}}}}},"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:brevo/contacts-update-multiple":{"post":{"operationId":"communication_brevo_contacts_update_multiple","summary":"Update multiple contacts","description":"POST /contacts/batch","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-get-email-campaign-stats":{"get":{"operationId":"communication_brevo_contacts_get_email_campaign_stats","summary":"Get email campaigns' statistics for a contact","description":"GET /contacts/{identifier}/campaignStats","tags":["communication"],"parameters":[{"name":"identifier","in":"query","required":true,"description":"Email (urlencoded) OR ID of the contact","schema":{"type":"string","description":"Email (urlencoded) OR ID of the contact"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to…","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be lower than equal to…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal to…","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the statistic events specific to campaigns. Must be greater than equal 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:brevo/contacts-list-attributes":{"get":{"operationId":"communication_brevo_contacts_list_attributes","summary":"List all attributes","description":"GET /contacts/attributes","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:brevo/contacts-create-attribute":{"post":{"operationId":"communication_brevo_contacts_create_attribute","summary":"Create contact attribute","description":"POST /contacts/attributes/{attributeCategory}/{attributeName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributeCategory","attributeName","body"],"properties":{"attributeCategory":{"type":"string","enum":["normal","transactional","category","calculated","global"],"description":"Category of the attribute"},"attributeName":{"type":"string","description":"Name of the attribute"},"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:brevo/contacts-update-attribute":{"post":{"operationId":"communication_brevo_contacts_update_attribute","summary":"Update contact attribute","description":"PUT /contacts/attributes/{attributeCategory}/{attributeName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributeCategory","attributeName","body"],"properties":{"attributeCategory":{"type":"string","enum":["category","calculated","global"],"description":"Category of the attribute"},"attributeName":{"type":"string","description":"Name of the existing attribute"},"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:brevo/contacts-remove-attribute":{"post":{"operationId":"communication_brevo_contacts_remove_attribute","summary":"Delete an attribute","description":"DELETE /contacts/attributes/{attributeCategory}/{attributeName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["attributeCategory","attributeName"],"properties":{"attributeCategory":{"type":"string","enum":["normal","transactional","category","calculated","global"],"description":"Category of the attribute"},"attributeName":{"type":"string","description":"Name of the existing attribute"}}}}}},"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:brevo/contacts-get-all-folders":{"get":{"operationId":"communication_brevo_contacts_get_all_folders","summary":"Get all folders","description":"GET /contacts/folders","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":true,"description":"Number of documents per page","schema":{"type":"integer","default":10,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":true,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/contacts-create-folder":{"post":{"operationId":"communication_brevo_contacts_create_folder","summary":"Create a folder","description":"POST /contacts/folders","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-get-folder-details":{"get":{"operationId":"communication_brevo_contacts_get_folder_details","summary":"Returns a folder's details","description":"GET /contacts/folders/{folderId}","tags":["communication"],"parameters":[{"name":"folderId","in":"query","required":true,"description":"id of the folder","schema":{"type":"integer","description":"id of the folder"}}],"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:brevo/contacts-update-folder":{"post":{"operationId":"communication_brevo_contacts_update_folder","summary":"Update a folder","description":"PUT /contacts/folders/{folderId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folderId","body"],"properties":{"folderId":{"type":"integer","description":"Id of the folder"},"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:brevo/contacts-delete-folder":{"post":{"operationId":"communication_brevo_contacts_delete_folder","summary":"Delete a folder (and all its lists)","description":"DELETE /contacts/folders/{folderId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["folderId"],"properties":{"folderId":{"type":"integer","description":"Id of the folder"}}}}}},"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:brevo/contacts-get-folder-lists":{"get":{"operationId":"communication_brevo_contacts_get_folder_lists","summary":"Get lists in a folder","description":"GET /contacts/folders/{folderId}/lists","tags":["communication"],"parameters":[{"name":"folderId","in":"query","required":true,"description":"Id of the folder","schema":{"type":"integer","description":"Id of the folder"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":10,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/contacts-get-all-lists":{"get":{"operationId":"communication_brevo_contacts_get_all_lists","summary":"Get all the lists","description":"GET /contacts/lists","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":10,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/contacts-create-list":{"post":{"operationId":"communication_brevo_contacts_create_list","summary":"Create a list","description":"POST /contacts/lists","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-get-list-details":{"get":{"operationId":"communication_brevo_contacts_get_list_details","summary":"Get a list's details","description":"GET /contacts/lists/{listId}","tags":["communication"],"parameters":[{"name":"listId","in":"query","required":true,"description":"Id of the list","schema":{"type":"integer","description":"Id of the list"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a…","schema":{"type":"string","description":"**Mandatory if endDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for a…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns for…","schema":{"type":"string","description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to aggregate the sent email campaigns 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:brevo/contacts-update-list":{"post":{"operationId":"communication_brevo_contacts_update_list","summary":"Update a list","description":"PUT /contacts/lists/{listId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listId","body"],"properties":{"listId":{"type":"integer","description":"Id of the list"},"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:brevo/contacts-delete-list":{"post":{"operationId":"communication_brevo_contacts_delete_list","summary":"Delete a list","description":"DELETE /contacts/lists/{listId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listId"],"properties":{"listId":{"type":"integer","description":"Id of the list"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-get-all-segments":{"get":{"operationId":"communication_brevo_contacts_get_all_segments","summary":"Get all the segments","description":"GET /contacts/segments","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":10,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/contacts-get-list-contacts":{"get":{"operationId":"communication_brevo_contacts_get_list_contacts","summary":"Get contacts in a list","description":"GET /contacts/lists/{listId}/contacts","tags":["communication"],"parameters":[{"name":"listId","in":"query","required":true,"description":"Id of the list","schema":{"type":"integer","description":"Id of the list"}},{"name":"modifiedSince","in":"query","required":false,"description":"Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the contacts modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/contacts-add-to-list":{"post":{"operationId":"communication_brevo_contacts_add_to_list","summary":"Add existing contacts to a list","description":"POST /contacts/lists/{listId}/contacts/add","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listId","body"],"properties":{"listId":{"type":"integer","description":"Id of the list"},"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:brevo/contacts-remove-contact-from-list":{"post":{"operationId":"communication_brevo_contacts_remove_contact_from_list","summary":"Delete a contact from a list","description":"POST /contacts/lists/{listId}/contacts/remove","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["listId","body"],"properties":{"listId":{"type":"integer","description":"Id of the list"},"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:brevo/contacts-export-process-id":{"post":{"operationId":"communication_brevo_contacts_export_process_id","summary":"Export contacts","description":"POST /contacts/export","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/contacts-import-contacts-process":{"post":{"operationId":"communication_brevo_contacts_import_contacts_process","summary":"Import contacts","description":"POST /contacts/import","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/sms-campaigns-get-all-information":{"get":{"operationId":"communication_brevo_sms_campaigns_get_all_information","summary":"Returns the information for all your created SMS campaigns","description":"GET /smsCampaigns","tags":["communication"],"parameters":[{"name":"status","in":"query","required":false,"description":"Status of campaign.","schema":{"type":"string","enum":["suspended","archive","sent","queued","draft","inProcess"],"description":"Status of campaign."}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns.…","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns.…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns.…","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the sent sms campaigns.…"}},{"name":"limit","in":"query","required":false,"description":"Number limitation for the result returned","schema":{"type":"integer","default":500,"description":"Number limitation for the result returned"}},{"name":"offset","in":"query","required":false,"description":"Beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Beginning point in the list to retrieve from."}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/sms-campaigns-create-campaign":{"post":{"operationId":"communication_brevo_sms_campaigns_create_campaign","summary":"Creates an SMS campaign","description":"POST /smsCampaigns","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/sms-campaigns-get-campaign-by-id":{"get":{"operationId":"communication_brevo_sms_campaigns_get_campaign_by_id","summary":"Get an SMS campaign","description":"GET /smsCampaigns/{campaignId}","tags":["communication"],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"id of the SMS campaign","schema":{"type":"integer","description":"id of the SMS campaign"}}],"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:brevo/sms-campaigns-update-campaign-by-id":{"post":{"operationId":"communication_brevo_sms_campaigns_update_campaign_by_id","summary":"Update an SMS campaign","description":"PUT /smsCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"id of the SMS campaign"},"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:brevo/sms-campaigns-remove-campaign-by-id":{"post":{"operationId":"communication_brevo_sms_campaigns_remove_campaign_by_id","summary":"Delete an SMS campaign","description":"DELETE /smsCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"id of the SMS campaign"}}}}}},"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:brevo/sms-campaigns-send-immediately":{"post":{"operationId":"communication_brevo_sms_campaigns_send_immediately","summary":"Send your SMS campaign immediately","description":"POST /smsCampaigns/{campaignId}/sendNow","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"}}}}}},"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:brevo/sms-campaigns-update-status":{"post":{"operationId":"communication_brevo_sms_campaigns_update_status","summary":"Update a campaign's status","description":"PUT /smsCampaigns/{campaignId}/status","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"},"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:brevo/sms-campaigns-send-test-sms":{"post":{"operationId":"communication_brevo_sms_campaigns_send_test_sms","summary":"Send a test SMS campaign","description":"POST /smsCampaigns/{campaignId}/sendTest","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"Id of the SMS campaign"},"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:brevo/sms-campaigns-export-recipients-process":{"post":{"operationId":"communication_brevo_sms_campaigns_export_recipients_process","summary":"Export an SMS campaign's recipients","description":"POST /smsCampaigns/{campaignId}/exportRecipients","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"},"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:brevo/sms-campaigns-send-campaign-report":{"post":{"operationId":"communication_brevo_sms_campaigns_send_campaign_report","summary":"Send an SMS campaign's report","description":"POST /smsCampaigns/{campaignId}/sendReport","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"},"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:brevo/transactional-sms-send-sms-message-to-mobile":{"post":{"operationId":"communication_brevo_transactional_sms_send_sms_message_to_mobile","summary":"Send SMS message to a mobile number","description":"POST /transactionalSMS/sms","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-sms-get-aggregated-report":{"get":{"operationId":"communication_brevo_transactional_sms_get_aggregated_report","summary":"Get your SMS activity aggregated over a period of time","description":"GET /transactionalSMS/statistics/aggregatedReport","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). **Not compatible with startDate and endDate**","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). **Not compatible with startDate and endDate**"}},{"name":"tag","in":"query","required":false,"description":"Filter on a tag","schema":{"type":"string","description":"Filter on a tag"}}],"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:brevo/transactional-sms-get-sms-activity-aggregated-per-day":{"get":{"operationId":"communication_brevo_transactional_sms_get_sms_activity_aggregated_per_day","summary":"Get your SMS activity aggregated per day","description":"GET /transactionalSMS/statistics/reports","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**"}},{"name":"tag","in":"query","required":false,"description":"Filter on a tag","schema":{"type":"string","description":"Filter on a tag"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/transactional-sms-get-all-events":{"get":{"operationId":"communication_brevo_transactional_sms_get_all_events","summary":"Get all your SMS activity (unaggregated events)","description":"GET /transactionalSMS/statistics/events","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","default":0,"description":"Index of the first document of the page"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'**"}},{"name":"phoneNumber","in":"query","required":false,"description":"Filter the report for a specific phone number","schema":{"type":"string","description":"Filter the report for a specific phone number"}},{"name":"event","in":"query","required":false,"description":"Filter the report for specific events","schema":{"type":"string","enum":["bounces","hardBounces","softBounces","delivered","sent","accepted","unsubscription","replies","blocked","rejected"],"description":"Filter the report for specific events"}},{"name":"tags","in":"query","required":false,"description":"Filter the report for specific tags passed as a serialized urlencoded array","schema":{"type":"string","description":"Filter the report for specific tags passed as a serialized urlencoded array"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/whats-app-campaigns-get-campaign-by-id":{"get":{"operationId":"communication_brevo_whats_app_campaigns_get_campaign_by_id","summary":"Get a WhatsApp campaign","description":"GET /whatsappCampaigns/{campaignId}","tags":["communication"],"parameters":[{"name":"campaignId","in":"query","required":true,"description":"Id of the campaign","schema":{"type":"integer","description":"Id of the campaign"}}],"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:brevo/whats-app-campaigns-update-campaign-by-id":{"post":{"operationId":"communication_brevo_whats_app_campaigns_update_campaign_by_id","summary":"Update a WhatsApp campaign","description":"PUT /whatsappCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId","body"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"},"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:brevo/whats-app-campaigns-delete-campaign":{"post":{"operationId":"communication_brevo_whats_app_campaigns_delete_campaign","summary":"Delete a WhatsApp campaign","description":"DELETE /whatsappCampaigns/{campaignId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["campaignId"],"properties":{"campaignId":{"type":"integer","description":"id of the campaign"}}}}}},"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:brevo/whats-app-campaigns-get-templates":{"get":{"operationId":"communication_brevo_whats_app_campaigns_get_templates","summary":"Return all your created WhatsApp templates","description":"GET /whatsappCampaigns/template-list","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer…","schema":{"type":"string","description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer…","schema":{"type":"string","description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created. **Prefer…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed"}},{"name":"source","in":"query","required":false,"description":"source of the template","schema":{"type":"string","enum":["Automation","Conversations"],"description":"source of the template"}}],"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:brevo/whats-app-campaigns-get-all":{"get":{"operationId":"communication_brevo_whats_app_campaigns_get_all","summary":"Return all your created WhatsApp campaigns","description":"GET /whatsappCampaigns","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created.…","schema":{"type":"string","description":"**Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created.…"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created.…","schema":{"type":"string","description":"**Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the WhatsApp campaigns created.…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed"}}],"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:brevo/whats-app-campaigns-create-and-send":{"post":{"operationId":"communication_brevo_whats_app_campaigns_create_and_send","summary":"Create and Send a WhatsApp campaign","description":"POST /whatsappCampaigns","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/whats-app-campaigns-create-template":{"post":{"operationId":"communication_brevo_whats_app_campaigns_create_template","summary":"Create a WhatsApp template","description":"POST /whatsappCampaigns/template","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/whats-app-campaigns-send-template-for-approval":{"post":{"operationId":"communication_brevo_whats_app_campaigns_send_template_for_approval","summary":"Send your WhatsApp template for approval","description":"POST /whatsappCampaigns/template/approval/{templateId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["templateId"],"properties":{"templateId":{"type":"integer","description":"id of the template"}}}}}},"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:brevo/whats-app-campaigns-get-account-info":{"get":{"operationId":"communication_brevo_whats_app_campaigns_get_account_info","summary":"Get your WhatsApp API account information","description":"GET /whatsappCampaigns/config","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:brevo/senders-list-all":{"get":{"operationId":"communication_brevo_senders_list_all","summary":"Get the list of all your senders","description":"GET /senders","tags":["communication"],"parameters":[{"name":"ip","in":"query","required":false,"description":"Filter your senders for a specific ip. **Available for dedicated IP usage only**","schema":{"type":"string","description":"Filter your senders for a specific ip. **Available for dedicated IP usage only**"}},{"name":"domain","in":"query","required":false,"description":"Filter your senders for a specific domain","schema":{"type":"string","description":"Filter your senders for a specific domain"}}],"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:brevo/senders-create-new-sender":{"post":{"operationId":"communication_brevo_senders_create_new_sender","summary":"Create a new sender","description":"POST /senders","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:brevo/senders-update-sender-by-id":{"post":{"operationId":"communication_brevo_senders_update_sender_by_id","summary":"Update a sender","description":"PUT /senders/{senderId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderId"],"properties":{"senderId":{"type":"integer","description":"Id of the sender"},"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:brevo/senders-remove-sender":{"post":{"operationId":"communication_brevo_senders_remove_sender","summary":"Delete a sender","description":"DELETE /senders/{senderId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderId"],"properties":{"senderId":{"type":"integer","description":"Id of the 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/senders-validate-sender-using-otp":{"post":{"operationId":"communication_brevo_senders_validate_sender_using_otp","summary":"Validate Sender using OTP","description":"PUT /senders/{senderId}/validate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["senderId"],"properties":{"senderId":{"type":"integer","description":"Id of the sender"},"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:brevo/senders-get-all-dedicated-ips":{"get":{"operationId":"communication_brevo_senders_get_all_dedicated_ips","summary":"Get all the dedicated IPs for a sender","description":"GET /senders/{senderId}/ips","tags":["communication"],"parameters":[{"name":"senderId","in":"query","required":true,"description":"Id of the sender","schema":{"type":"integer","description":"Id of the 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:brevo/senders-get-dedicated-ips":{"get":{"operationId":"communication_brevo_senders_get_dedicated_ips","summary":"Get all the dedicated IPs for your account","description":"GET /senders/ips","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:brevo/domains-get-all":{"get":{"operationId":"communication_brevo_domains_get_all","summary":"Get the list of all your domains","description":"GET /senders/domains","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:brevo/domains-create-new-domain":{"post":{"operationId":"communication_brevo_domains_create_new_domain","summary":"Create a new domain","description":"POST /senders/domains","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:brevo/domains-validate-configuration":{"get":{"operationId":"communication_brevo_domains_validate_configuration","summary":"Validate domain configuration","description":"GET /senders/domains/{domainName}","tags":["communication"],"parameters":[{"name":"domainName","in":"query","required":true,"description":"Domain name","schema":{"type":"string","description":"Domain name"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:brevo/domains-delete-domain":{"post":{"operationId":"communication_brevo_domains_delete_domain","summary":"Delete a domain","description":"DELETE /senders/domains/{domainName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName"],"properties":{"domainName":{"type":"string","description":"Domain name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/domains-authenticate-domain":{"post":{"operationId":"communication_brevo_domains_authenticate_domain","summary":"Authenticate a domain","description":"PUT /senders/domains/{domainName}/authenticate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["domainName"],"properties":{"domainName":{"type":"string","description":"Domain name"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/webhooks-get-all":{"get":{"operationId":"communication_brevo_webhooks_get_all","summary":"Get all webhooks","description":"GET /webhooks","tags":["communication"],"parameters":[{"name":"type","in":"query","required":false,"description":"Filter on webhook type","schema":{"type":"string","enum":["marketing","transactional","inbound"],"default":"transactional","description":"Filter on webhook type"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of webhook creation","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of webhook creation"}}],"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:brevo/webhooks-create-hook":{"post":{"operationId":"communication_brevo_webhooks_create_hook","summary":"Create a webhook","description":"POST /webhooks","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/webhooks-get-details":{"get":{"operationId":"communication_brevo_webhooks_get_details","summary":"Get a webhook details","description":"GET /webhooks/{webhookId}","tags":["communication"],"parameters":[{"name":"webhookId","in":"query","required":true,"description":"Id of the webhook","schema":{"type":"integer","description":"Id of the 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:brevo/webhooks-update-webhook-by-id":{"post":{"operationId":"communication_brevo_webhooks_update_webhook_by_id","summary":"Update a webhook","description":"PUT /webhooks/{webhookId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId","body"],"properties":{"webhookId":{"type":"integer","description":"Id of the 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:brevo/webhooks-delete-webhook":{"post":{"operationId":"communication_brevo_webhooks_delete_webhook","summary":"Delete a webhook","description":"DELETE /webhooks/{webhookId}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhookId"],"properties":{"webhookId":{"type":"integer","description":"Id of the 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:brevo/webhooks-export-all-events":{"post":{"operationId":"communication_brevo_webhooks_export_all_events","summary":"Export all webhook events","description":"POST /webhooks/export","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/reseller-list-children-accounts":{"get":{"operationId":"communication_brevo_reseller_list_children_accounts","summary":"Get the list of all children accounts","description":"GET /reseller/children","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents for child accounts information per page","schema":{"type":"integer","default":10,"description":"Number of documents for child accounts information per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the 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:brevo/reseller-create-child":{"post":{"operationId":"communication_brevo_reseller_create_child","summary":"Creates a reseller child","description":"POST /reseller/children","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:brevo/reseller-get-child-details":{"get":{"operationId":"communication_brevo_reseller_get_child_details","summary":"Get a child account's details","description":"GET /reseller/children/{childIdentifier}","tags":["communication"],"parameters":[{"name":"childIdentifier","in":"query","required":true,"description":"Either auth key or id of reseller's child","schema":{"type":"string","description":"Either auth key or id of reseller's child"}}],"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:brevo/reseller-update-child-info":{"post":{"operationId":"communication_brevo_reseller_update_child_info","summary":"Update info of reseller's child based on the child identifier supplied","description":"PUT /reseller/children/{childIdentifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-delete-child-by-identifier":{"post":{"operationId":"communication_brevo_reseller_delete_child_by_identifier","summary":"Delete a single reseller child based on the child identifier supplied","description":"DELETE /reseller/children/{childIdentifier}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or child id of reseller's child"}}}}}},"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:brevo/reseller-update-child-account-status":{"post":{"operationId":"communication_brevo_reseller_update_child_account_status","summary":"Update info of reseller's child account status based on the identifier supplied","description":"PUT /reseller/children/{childIdentifier}/accountStatus","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-get-child-account-creation-status":{"get":{"operationId":"communication_brevo_reseller_get_child_account_creation_status","summary":"Get the status of a reseller's child account creation, whether it is successfully created (exists) or not…","description":"GET /reseller/children/{childIdentifier}/accountCreationStatus","tags":["communication"],"parameters":[{"name":"childIdentifier","in":"query","required":true,"description":"Either auth key or id of reseller's child","schema":{"type":"string","description":"Either auth key or id of reseller's child"}}],"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:brevo/reseller-associate-dedicated-ip-to-child":{"post":{"operationId":"communication_brevo_reseller_associate_dedicated_ip_to_child","summary":"Associate a dedicated IP to the child","description":"POST /reseller/children/{childIdentifier}/ips/associate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-dissociate-ip-to-child":{"post":{"operationId":"communication_brevo_reseller_dissociate_ip_to_child","summary":"Dissociate a dedicated IP to the child","description":"POST /reseller/children/{childIdentifier}/ips/dissociate","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-add-child-credits":{"post":{"operationId":"communication_brevo_reseller_add_child_credits","summary":"Add Email and/or SMS credits to a specific child account","description":"POST /reseller/children/{childIdentifier}/credits/add","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-remove-credits-from-child":{"post":{"operationId":"communication_brevo_reseller_remove_credits_from_child","summary":"Remove Email and/or SMS credits from a specific child account","description":"POST /reseller/children/{childIdentifier}/credits/remove","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-get-child-domains":{"get":{"operationId":"communication_brevo_reseller_get_child_domains","summary":"Get all sender domains for a specific child account","description":"GET /reseller/children/{childIdentifier}/domains","tags":["communication"],"parameters":[{"name":"childIdentifier","in":"query","required":true,"description":"Either auth key or id of reseller's child","schema":{"type":"string","description":"Either auth key or id of reseller's child"}}],"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:brevo/reseller-create-child-domain":{"post":{"operationId":"communication_brevo_reseller_create_child_domain","summary":"Create a domain for a child account","description":"POST /reseller/children/{childIdentifier}/domains","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"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:brevo/reseller-update-sender-domain":{"post":{"operationId":"communication_brevo_reseller_update_sender_domain","summary":"Update the sender domain of reseller's child based on the childIdentifier and domainName passed","description":"PUT /reseller/children/{childIdentifier}/domains/{domainName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","domainName","body"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"domainName":{"type":"string","description":"Pass the existing domain that needs to be updated"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/reseller-delete-sender-domain-by-child-identifier-and-domain":{"post":{"operationId":"communication_brevo_reseller_delete_sender_domain_by_child_identifier_and_domain","summary":"Delete the sender domain of the reseller child based on the childIdentifier and domainName passed","description":"DELETE /reseller/children/{childIdentifier}/domains/{domainName}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["childIdentifier","domainName"],"properties":{"childIdentifier":{"type":"string","description":"Either auth key or id of reseller's child"},"domainName":{"type":"string","description":"Pass the existing domain that needs to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/reseller-get-session-token":{"get":{"operationId":"communication_brevo_reseller_get_session_token","summary":"Get session token to access Brevo (SSO)","description":"GET /reseller/children/{childIdentifier}/auth","tags":["communication"],"parameters":[{"name":"childIdentifier","in":"query","required":true,"description":"Either auth key or id of reseller's child","schema":{"type":"string","description":"Either auth key or id of reseller's child"}}],"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:brevo/account-information-details":{"get":{"operationId":"communication_brevo_account_information_details","summary":"Get your account information, plan and credits details","description":"GET /account","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:brevo/account-get-user-activity-logs":{"get":{"operationId":"communication_brevo_account_get_user_activity_logs","summary":"Get user activity logs","description":"GET /organization/activities","tags":["communication"],"parameters":[{"name":"startDate","in":"query","required":false,"description":"Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period…","schema":{"type":"string","description":"Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period…"}},{"name":"endDate","in":"query","required":false,"description":"Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period…","schema":{"type":"string","description":"Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD) format to filter the activity in your account. Maximum time period…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":10,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page.","schema":{"type":"integer","default":0,"description":"Index of the first document in the 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:brevo/user-get-all-users":{"get":{"operationId":"communication_brevo_user_get_all_users","summary":"Get the list of all your users","description":"GET /organization/invited/users","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:brevo/user-check-permission":{"get":{"operationId":"communication_brevo_user_check_permission","summary":"Check user permission","description":"GET /organization/user/{email}/permissions","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"Email of the invited user.","schema":{"type":"string","description":"Email of the invited user."}}],"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:brevo/user-revoke-permission-by-email":{"post":{"operationId":"communication_brevo_user_revoke_permission_by_email","summary":"Revoke user permission","description":"PUT /organization/user/invitation/revoke/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email of the invited user."}}}}}},"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:brevo/user-resend-invitation":{"post":{"operationId":"communication_brevo_user_resend_invitation","summary":"Resend / Cancel invitation","description":"PUT /organization/user/invitation/{action}/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action","email"],"properties":{"action":{"type":"string","enum":["resend","cancel"],"description":"action"},"email":{"type":"string","description":"Email of the invited user."}}}}}},"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:brevo/user-send-invitation":{"post":{"operationId":"communication_brevo_user_send_invitation","summary":"Send invitation to user","description":"POST /organization/user/invitation/send","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/user-update-permissions":{"post":{"operationId":"communication_brevo_user_update_permissions","summary":"Update permission for a user","description":"POST /organization/user/update/permissions","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/process-get-all-processes":{"get":{"operationId":"communication_brevo_process_get_all_processes","summary":"Return all the processes for your account","description":"GET /processes","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number limitation for the result returned","schema":{"type":"integer","default":10,"description":"Number limitation for the result returned"}},{"name":"offset","in":"query","required":false,"description":"Beginning point in the list to retrieve from.","schema":{"type":"integer","default":0,"description":"Beginning point in the list to retrieve from."}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/process-get-process-information":{"get":{"operationId":"communication_brevo_process_get_process_information","summary":"Return the informations for a process","description":"GET /processes/{processId}","tags":["communication"],"parameters":[{"name":"processId","in":"query","required":true,"description":"Id of the process","schema":{"type":"integer","description":"Id of the process"}}],"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:brevo/inbound-parsing-get-all-events":{"get":{"operationId":"communication_brevo_inbound_parsing_get_all_events","summary":"Get the list of all the events for the received emails.","description":"GET /inbound/events","tags":["communication"],"parameters":[{"name":"sender","in":"query","required":false,"description":"Email address of the sender.","schema":{"type":"string","description":"Email address of the sender."}},{"name":"startDate","in":"query","required":false,"description":"Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time…","schema":{"type":"string","description":"Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) from which you want to fetch the list. Maximum time…"}},{"name":"endDate","in":"query","required":false,"description":"Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time…","schema":{"type":"string","description":"Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ) till which you want to fetch the list. Maximum time…"}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":100,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page","schema":{"type":"integer","default":0,"description":"Index of the first document on the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation"}}],"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:brevo/inbound-parsing-get-email-events":{"get":{"operationId":"communication_brevo_inbound_parsing_get_email_events","summary":"Fetch all events history for one particular received email.","description":"GET /inbound/events/{uuid}","tags":["communication"],"parameters":[{"name":"uuid","in":"query","required":true,"description":"UUID to fetch events specific to recieved email","schema":{"type":"string","description":"UUID to fetch events specific to recieved email"}}],"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:brevo/inbound-parsing-get-attachment-by-token":{"get":{"operationId":"communication_brevo_inbound_parsing_get_attachment_by_token","summary":"Retrieve inbound attachment with download token.","description":"GET /inbound/attachments/{downloadToken}","tags":["communication"],"parameters":[{"name":"downloadToken","in":"query","required":true,"description":"Token to fetch a particular attachment","schema":{"type":"string","description":"Token to fetch a particular attachment"}}],"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:brevo/master-account-list-sub-accounts":{"get":{"operationId":"communication_brevo_master_account_list_sub_accounts","summary":"Get the list of all the sub-accounts of the master account.","description":"GET /corporate/subAccount","tags":["communication"],"parameters":[{"name":"offset","in":"query","required":true,"description":"Index of the first sub-account in the page","schema":{"type":"integer","description":"Index of the first sub-account in the page"}},{"name":"limit","in":"query","required":true,"description":"Number of sub-accounts to be displayed on each page","schema":{"type":"integer","description":"Number of sub-accounts to be displayed on each 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:brevo/master-account-create-sub-account":{"post":{"operationId":"communication_brevo_master_account_create_sub_account","summary":"Create a new sub-account under a master account.","description":"POST /corporate/subAccount","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/master-account-get-sub-account-details":{"get":{"operationId":"communication_brevo_master_account_get_sub_account_details","summary":"Get sub-account details","description":"GET /corporate/subAccount/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the sub-account organization","schema":{"type":"integer","description":"Id of the sub-account organization"}}],"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:brevo/master-account-delete-sub-account":{"post":{"operationId":"communication_brevo_master_account_delete_sub_account","summary":"Delete a sub-account","description":"DELETE /corporate/subAccount/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"integer","description":"Id of the sub-account organization to be deleted"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/master-account-update-sub-account-plan":{"post":{"operationId":"communication_brevo_master_account_update_sub_account_plan","summary":"Update sub-account plan","description":"PUT /corporate/subAccount/{id}/plan","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"Id of the sub-account organization"},"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:brevo/master-account-generate-sso-token":{"post":{"operationId":"communication_brevo_master_account_generate_sso_token","summary":"Generate SSO token to access admin account","description":"POST /corporate/ssoToken","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:brevo/master-account-generate-sso-token-2":{"post":{"operationId":"communication_brevo_master_account_generate_sso_token_2","summary":"Generate SSO token to access sub-account","description":"POST /corporate/subAccount/ssoToken","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:brevo/master-account-get-details":{"get":{"operationId":"communication_brevo_master_account_get_details","summary":"Get the details of requested master account","description":"GET /corporate/masterAccount","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:brevo/master-account-create-sub-account-key":{"post":{"operationId":"communication_brevo_master_account_create_sub_account_key","summary":"Create an API key for a sub-account","description":"POST /corporate/subAccount/key","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:brevo/master-account-enable-disable":{"post":{"operationId":"communication_brevo_master_account_enable_disable","summary":"Enable/disable sub-account application(s)","description":"PUT /corporate/subAccount/{id}/applications/toggle","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"integer","description":"Id of the sub-account organization (mandatory)"},"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:brevo/master-account-create-group-of-sub-accounts":{"post":{"operationId":"communication_brevo_master_account_create_group_of_sub_accounts","summary":"Create a group of sub-accounts","description":"POST /corporate/group","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:brevo/master-account-get-group-details":{"get":{"operationId":"communication_brevo_master_account_get_group_details","summary":"GET a group details","description":"GET /corporate/group/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the group of sub-organization","schema":{"type":"string","description":"Id of the group of sub-organization"}}],"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:brevo/master-account-update-group-sub-accounts":{"post":{"operationId":"communication_brevo_master_account_update_group_sub_accounts","summary":"Update a group of sub-accounts","description":"PUT /corporate/group/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Id of the group"},"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:brevo/master-account-delete-group":{"post":{"operationId":"communication_brevo_master_account_delete_group","summary":"Delete a group","description":"DELETE /corporate/group/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the group"}}}}}},"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:brevo/master-account-unlink-sub-account-from-group":{"post":{"operationId":"communication_brevo_master_account_unlink_sub_account_from_group","summary":"Delete sub-account from group","description":"PUT /corporate/group/unlink/{groupId}/subAccounts","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["groupId","body"],"properties":{"groupId":{"type":"string","description":"Group id"},"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:brevo/master-account-send-invitation-to-admin-user":{"post":{"operationId":"communication_brevo_master_account_send_invitation_to_admin_user","summary":"Send invitation to an admin user","description":"POST /corporate/user/invitation/send","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/master-account-resend-cancel-admin-user-invitation":{"post":{"operationId":"communication_brevo_master_account_resend_cancel_admin_user_invitation","summary":"Resend / cancel admin user invitation","description":"PUT /corporate/user/invitation/{action}/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["action","email"],"properties":{"action":{"type":"string","enum":["resend","cancel"],"description":"Action to be performed (cancel / resend)"},"email":{"type":"string","description":"Email address of the recipient"}}}}}},"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:brevo/master-account-revoke-admin-user":{"post":{"operationId":"communication_brevo_master_account_revoke_admin_user","summary":"Revoke an admin user","description":"DELETE /corporate/user/revoke/{email}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["email"],"properties":{"email":{"type":"string","description":"Email of the invited user"}}}}}},"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:brevo/master-account-list-admin-users":{"get":{"operationId":"communication_brevo_master_account_list_admin_users","summary":"Get the list of all admin users","description":"GET /corporate/invited/users","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:brevo/master-account-check-admin-user-permissions":{"get":{"operationId":"communication_brevo_master_account_check_admin_user_permissions","summary":"Check admin user permissions","description":"GET /corporate/user/{email}/permissions","tags":["communication"],"parameters":[{"name":"email","in":"query","required":true,"description":"Email of the invited user.","schema":{"type":"string","description":"Email of the invited user."}}],"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:brevo/master-account-list-groups":{"get":{"operationId":"communication_brevo_master_account_list_groups","summary":"Get the list of groups","description":"GET /corporate/groups","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:brevo/companies-get-all":{"get":{"operationId":"communication_brevo_companies_get_all","summary":"Get all Companies","description":"GET /companies","tags":["communication"],"parameters":[{"name":"filters","in":"query","required":false,"description":"Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"6299dcf3874a14eacbc65c46\"}","schema":{"type":"string","description":"Filter by attrbutes. If you have filter for owner on your side please send it as {\"attributes.owner\":\"6299dcf3874a14eacbc65c46\"}"}},{"name":"linkedContactsIds","in":"query","required":false,"description":"Filter by linked contacts ids","schema":{"type":"integer","description":"Filter by linked contacts ids"}},{"name":"linkedDealsIds","in":"query","required":false,"description":"Filter by linked Deals ids","schema":{"type":"string","description":"Filter by linked Deals ids"}},{"name":"page","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","description":"Index of the first document of the page"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","description":"Number of documents per page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed"}},{"name":"sortBy","in":"query","required":false,"description":"The field used to sort field names.","schema":{"type":"string","description":"The field used to sort field names."}}],"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:brevo/companies-create-company":{"post":{"operationId":"communication_brevo_companies_create_company","summary":"Create a company","description":"POST /companies","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/companies-get-company-by-id":{"get":{"operationId":"communication_brevo_companies_get_company_by_id","summary":"Get a company","description":"GET /companies/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Get Company Details","schema":{"type":"string","description":"Get Company Details"}}],"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:brevo/companies-update-company":{"post":{"operationId":"communication_brevo_companies_update_company","summary":"Update a company","description":"PATCH /companies/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/companies-delete-company":{"post":{"operationId":"communication_brevo_companies_delete_company","summary":"Delete a company","description":"DELETE /companies/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Company ID to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/companies-get-attributes":{"get":{"operationId":"communication_brevo_companies_get_attributes","summary":"Get company attributes","description":"GET /companies/attributes","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:brevo/companies-link-unlink-with-contact-deal":{"post":{"operationId":"communication_brevo_companies_link_unlink_with_contact_deal","summary":"Link and Unlink company with contact and deal","description":"PATCH /companies/link-unlink/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/deals-get-details":{"get":{"operationId":"communication_brevo_deals_get_details","summary":"Get a pipeline","description":"GET /crm/pipeline/details/{pipelineID}","tags":["communication"],"parameters":[{"name":"pipelineID","in":"query","required":true,"schema":{"type":"string"}}],"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:brevo/deals-get-all-pipelines":{"get":{"operationId":"communication_brevo_deals_get_all_pipelines","summary":"Get all pipelines","description":"GET /crm/pipeline/details/all","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:brevo/deals-get-attributes":{"get":{"operationId":"communication_brevo_deals_get_attributes","summary":"Get deal attributes","description":"GET /crm/attributes/deals","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:brevo/deals-get-all-deals":{"get":{"operationId":"communication_brevo_deals_get_all_deals","summary":"Get all deals","description":"GET /crm/deals","tags":["communication"],"parameters":[{"name":"filters[attributes.deal_name]","in":"query","required":false,"description":"Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the…","schema":{"type":"string","description":"Filter by attributes. If you have a filter for the owner on your end, please send it as filters[attributes.deal_owner] and utilize the…"}},{"name":"filters[linkedCompaniesIds]","in":"query","required":false,"description":"Filter by linked companies ids","schema":{"type":"string","description":"Filter by linked companies ids"}},{"name":"filters[linkedContactsIds]","in":"query","required":false,"description":"Filter by linked companies ids","schema":{"type":"string","description":"Filter by linked companies ids"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","description":"Index of the first document of the page"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","description":"Number of documents per page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed"}}],"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:brevo/deals-create-new-deal":{"post":{"operationId":"communication_brevo_deals_create_new_deal","summary":"Create a deal","description":"POST /crm/deals","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/deals-get-by-id":{"get":{"operationId":"communication_brevo_deals_get_by_id","summary":"Get a deal","description":"GET /crm/deals/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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:brevo/deals-update-deal-by-id":{"post":{"operationId":"communication_brevo_deals_update_deal_by_id","summary":"Update a deal","description":"PATCH /crm/deals/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/deals-delete-deal":{"post":{"operationId":"communication_brevo_deals_delete_deal","summary":"Delete a deal","description":"DELETE /crm/deals/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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:brevo/deals-link-unlink-patch":{"post":{"operationId":"communication_brevo_deals_link_unlink_patch","summary":"Link and Unlink a deal with contacts and companies","description":"PATCH /crm/deals/link-unlink/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/tasks-get-all-task-types":{"get":{"operationId":"communication_brevo_tasks_get_all_task_types","summary":"Get all task types","description":"GET /crm/tasktypes","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:brevo/tasks-get-all":{"get":{"operationId":"communication_brevo_tasks_get_all","summary":"Get all tasks","description":"GET /crm/tasks","tags":["communication"],"parameters":[{"name":"filter[type]","in":"query","required":false,"description":"Filter by task type (ID)","schema":{"type":"string","description":"Filter by task type (ID)"}},{"name":"filter[status]","in":"query","required":false,"description":"Filter by task status","schema":{"type":"string","enum":["done","undone"],"description":"Filter by task status"}},{"name":"filter[date]","in":"query","required":false,"description":"Filter by date","schema":{"type":"string","enum":["overdue","today","tomorrow","week","range"],"description":"Filter by date"}},{"name":"filter[assignTo]","in":"query","required":false,"description":"Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute.","schema":{"type":"string","description":"Filter by the \"assignTo\" ID. You can utilize account emails for the \"assignTo\" attribute."}},{"name":"filter[contacts]","in":"query","required":false,"description":"Filter by contact ids","schema":{"type":"string","description":"Filter by contact ids"}},{"name":"filter[deals]","in":"query","required":false,"description":"Filter by deals ids","schema":{"type":"string","description":"Filter by deals ids"}},{"name":"filter[companies]","in":"query","required":false,"description":"Filter by companies ids","schema":{"type":"string","description":"Filter by companies ids"}},{"name":"dateFrom","in":"query","required":false,"description":"dateFrom to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateFrom to date range filter type (timestamp in milliseconds)"}},{"name":"dateTo","in":"query","required":false,"description":"dateTo to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateTo to date range filter type (timestamp in milliseconds)"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","description":"Index of the first document of the page"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed"}},{"name":"sortBy","in":"query","required":false,"description":"The field used to sort field names.","schema":{"type":"string","description":"The field used to sort field names."},"example":"name"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/communication:brevo/tasks-create-new-task":{"post":{"operationId":"communication_brevo_tasks_create_new_task","summary":"Create a task","description":"POST /crm/tasks","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/tasks-get-task-by-id":{"get":{"operationId":"communication_brevo_tasks_get_task_by_id","summary":"Get a task","description":"GET /crm/tasks/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"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:brevo/tasks-update-task":{"post":{"operationId":"communication_brevo_tasks_update_task","summary":"Update a task","description":"PATCH /crm/tasks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/tasks-remove-task":{"post":{"operationId":"communication_brevo_tasks_remove_task","summary":"Delete a task","description":"DELETE /crm/tasks/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string"}}}}}},"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:brevo/notes-get-all":{"get":{"operationId":"communication_brevo_notes_get_all","summary":"Get all notes","description":"GET /crm/notes","tags":["communication"],"parameters":[{"name":"entity","in":"query","required":false,"description":"Filter by note entity type","schema":{"type":"string","enum":["companies","deals","contacts"],"description":"Filter by note entity type"}},{"name":"entityIds","in":"query","required":false,"description":"Filter by note entity IDs","schema":{"type":"string","description":"Filter by note entity IDs"}},{"name":"dateFrom","in":"query","required":false,"description":"dateFrom to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateFrom to date range filter type (timestamp in milliseconds)"}},{"name":"dateTo","in":"query","required":false,"description":"dateTo to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateTo to date range filter type (timestamp in milliseconds)"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","description":"Index of the first document of the page"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed"}}],"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:brevo/notes-create-new-note":{"post":{"operationId":"communication_brevo_notes_create_new_note","summary":"Create a note","description":"POST /crm/notes","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/notes-get-by-id":{"get":{"operationId":"communication_brevo_notes_get_by_id","summary":"Get a note","description":"GET /crm/notes/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Note ID to get","schema":{"type":"string","description":"Note ID to get"}}],"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:brevo/notes-update-note-by-id":{"post":{"operationId":"communication_brevo_notes_update_note_by_id","summary":"Update a note","description":"PATCH /crm/notes/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"Note ID to update"},"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:brevo/notes-remove-by-id":{"post":{"operationId":"communication_brevo_notes_remove_by_id","summary":"Delete a note","description":"DELETE /crm/notes/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Note ID to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/files-get-all-files":{"get":{"operationId":"communication_brevo_files_get_all_files","summary":"Get all files","description":"GET /crm/files","tags":["communication"],"parameters":[{"name":"entity","in":"query","required":false,"description":"Filter by file entity type","schema":{"type":"string","enum":["companies","deals","contacts"],"description":"Filter by file entity type"}},{"name":"entityIds","in":"query","required":false,"description":"Filter by file entity IDs","schema":{"type":"string","description":"Filter by file entity IDs"}},{"name":"dateFrom","in":"query","required":false,"description":"dateFrom to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateFrom to date range filter type (timestamp in milliseconds)"}},{"name":"dateTo","in":"query","required":false,"description":"dateTo to date range filter type (timestamp in milliseconds)","schema":{"type":"integer","description":"dateTo to date range filter type (timestamp in milliseconds)"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document of the page","schema":{"type":"integer","description":"Index of the first document of the page"}},{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"description":"Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed"}}],"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:brevo/files-upload-file":{"post":{"operationId":"communication_brevo_files_upload_file","summary":"Upload a file","description":"POST /crm/files","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"Form fields as a JSON object"}}}}}},"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:brevo/files-download-file":{"get":{"operationId":"communication_brevo_files_download_file","summary":"Download a file","description":"GET /crm/files/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"File id to download.","schema":{"type":"string","description":"File id to download."}}],"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:brevo/files-delete-file":{"post":{"operationId":"communication_brevo_files_delete_file","summary":"Delete a file","description":"DELETE /crm/files/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"File id to delete."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/files-get-file-details":{"get":{"operationId":"communication_brevo_files_get_file_details","summary":"Get file details","description":"GET /crm/files/{id}/data","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"File id to get file data.","schema":{"type":"string","description":"File id to get file data."}}],"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:brevo/conversations-send-message-as-agent":{"post":{"operationId":"communication_brevo_conversations_send_message_as_agent","summary":"Send a message as an agent","description":"POST /conversations/messages","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/conversations-get-message-by-id":{"get":{"operationId":"communication_brevo_conversations_get_message_by_id","summary":"Get a message","description":"GET /conversations/messages/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the message","schema":{"type":"string","description":"ID of the 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:brevo/conversations-update-agent-message":{"post":{"operationId":"communication_brevo_conversations_update_agent_message","summary":"Update a message sent by an agent","description":"PUT /conversations/messages/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"ID of the message"},"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:brevo/conversations-delete-message-sent-by-agent":{"post":{"operationId":"communication_brevo_conversations_delete_message_sent_by_agent","summary":"Delete a message sent by an agent","description":"DELETE /conversations/messages/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/conversations-send-automated-message":{"post":{"operationId":"communication_brevo_conversations_send_automated_message","summary":"Send an automated message to a visitor","description":"POST /conversations/pushedMessages","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/conversations-get-automated-message":{"get":{"operationId":"communication_brevo_conversations_get_automated_message","summary":"Get an automated message","description":"GET /conversations/pushedMessages/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"ID of the message sent previously","schema":{"type":"string","description":"ID of the message sent previously"}}],"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:brevo/conversations-update-pushed-message":{"post":{"operationId":"communication_brevo_conversations_update_pushed_message","summary":"Update an automated message","description":"PUT /conversations/pushedMessages/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id","body"],"properties":{"id":{"type":"string","description":"ID of the message"},"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:brevo/conversations-delete-automated-message":{"post":{"operationId":"communication_brevo_conversations_delete_automated_message","summary":"Delete an automated message","description":"DELETE /conversations/pushedMessages/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the 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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/conversations-set-agent-online-status":{"post":{"operationId":"communication_brevo_conversations_set_agent_online_status","summary":"Sets agent’s status to online for 2-3 minutes","description":"POST /conversations/agentOnlinePing","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-activate-app":{"post":{"operationId":"communication_brevo_ecommerce_activate_app","summary":"Activate the eCommerce app","description":"POST /ecommerce/activate","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":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-get-attribution-metrics":{"get":{"operationId":"communication_brevo_ecommerce_get_attribution_metrics","summary":"Get attribution metrics for one or more Brevo campaigns","description":"GET /ecommerce/attribution/metrics","tags":["communication"],"parameters":[{"name":"periodFrom","in":"query","required":false,"description":"When getting metrics for a specific period, define the starting datetime in RFC3339 format","schema":{"type":"string","description":"When getting metrics for a specific period, define the starting datetime in RFC3339 format"}},{"name":"periodTo","in":"query","required":false,"description":"When getting metrics for a specific period, define the end datetime in RFC3339 format","schema":{"type":"string","description":"When getting metrics for a specific period, define the end datetime in RFC3339 format"}},{"name":"emailCampaignId[]","in":"query","required":false,"description":"The email campaign id(s) to get metrics for","schema":{"type":"array","description":"The email campaign id(s) to get metrics 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:brevo/ecommerce-get-attribution-metrics-2":{"get":{"operationId":"communication_brevo_ecommerce_get_attribution_metrics_2","summary":"Get detailed attribution metrics for a single Brevo campaign","description":"GET /ecommerce/attribution/metrics/{conversionSource}/{conversionSourceId}","tags":["communication"],"parameters":[{"name":"conversionSource","in":"query","required":true,"description":"The Brevo campaign type for which data will be retrieved","schema":{"type":"string","enum":["email_campaign"],"description":"The Brevo campaign type for which data will be retrieved"}},{"name":"conversionSourceId","in":"query","required":true,"description":"The Brevo campaign id for which data will be retrieved","schema":{"type":"number","description":"The Brevo campaign id for which data will be retrieved"}}],"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:brevo/ecommerce-get-attributed-product-sales":{"get":{"operationId":"communication_brevo_ecommerce_get_attributed_product_sales","summary":"Get attributed product sales for a single Brevo campaign","description":"GET /ecommerce/attribution/products/{conversionSource}/{conversionSourceId}","tags":["communication"],"parameters":[{"name":"conversionSource","in":"query","required":true,"description":"The Brevo campaign type for which data will be retrieved","schema":{"type":"string","enum":["email_campaign"],"description":"The Brevo campaign type for which data will be retrieved"}},{"name":"conversionSourceId","in":"query","required":true,"description":"The Brevo campaign id for which data will be retrieved","schema":{"type":"number","description":"The Brevo campaign id for which data will be retrieved"}}],"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:brevo/ecommerce-get-orders":{"get":{"operationId":"communication_brevo_ecommerce_get_orders","summary":"Get order details","description":"GET /orders","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"modifiedSince","in":"query","required":false,"description":"Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"createdSince","in":"query","required":false,"description":"Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time…","schema":{"type":"string","description":"Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time…"}}],"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:brevo/ecommerce-manage-order-status":{"post":{"operationId":"communication_brevo_ecommerce_manage_order_status","summary":"Managing the status of the order","description":"POST /orders/status","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-create-order-batch":{"post":{"operationId":"communication_brevo_ecommerce_create_order_batch","summary":"Create orders in batch","description":"POST /orders/status/batch","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/event-track-interaction":{"post":{"operationId":"communication_brevo_event_track_interaction","summary":"Create an event","description":"POST /events","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-get-all-categories":{"get":{"operationId":"communication_brevo_ecommerce_get_all_categories","summary":"Return all your categories","description":"GET /categories","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"ids","in":"query","required":false,"description":"Filter by category ids","schema":{"type":"array","description":"Filter by category ids"}},{"name":"name","in":"query","required":false,"description":"Filter by category name","schema":{"type":"string","description":"Filter by category name"}},{"name":"modifiedSince","in":"query","required":false,"description":"Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the categories modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"createdSince","in":"query","required":false,"description":"Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the categories created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone 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:brevo/ecommerce-create-category":{"post":{"operationId":"communication_brevo_ecommerce_create_category","summary":"Create/Update a category","description":"POST /categories","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-get-category-details":{"get":{"operationId":"communication_brevo_ecommerce_get_category_details","summary":"Get a category details","description":"GET /categories/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Category ID","schema":{"type":"string","description":"Category 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:brevo/ecommerce-create-categories-batch":{"post":{"operationId":"communication_brevo_ecommerce_create_categories_batch","summary":"Create categories in batch","description":"POST /categories/batch","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-list-all-products":{"get":{"operationId":"communication_brevo_ecommerce_list_all_products","summary":"Return all your products","description":"GET /products","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents per page","schema":{"type":"integer","default":50,"description":"Number of documents per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document in the page","schema":{"type":"integer","default":0,"description":"Index of the first document in the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}},{"name":"ids","in":"query","required":false,"description":"Filter by product ids","schema":{"type":"array","description":"Filter by product ids"}},{"name":"name","in":"query","required":false,"description":"Filter by product name, minimum 3 characters should be present for search","schema":{"type":"string","description":"Filter by product name, minimum 3 characters should be present for search"}},{"name":"price[lte]","in":"query","required":false,"description":"Price filter for products less than and equals to particular amount","schema":{"type":"number","description":"Price filter for products less than and equals to particular amount"}},{"name":"price[gte]","in":"query","required":false,"description":"Price filter for products greater than and equals to particular amount","schema":{"type":"number","description":"Price filter for products greater than and equals to particular amount"}},{"name":"price[lt]","in":"query","required":false,"description":"Price filter for products less than particular amount","schema":{"type":"number","description":"Price filter for products less than particular amount"}},{"name":"price[gt]","in":"query","required":false,"description":"Price filter for products greater than particular amount","schema":{"type":"number","description":"Price filter for products greater than particular amount"}},{"name":"price[eq]","in":"query","required":false,"description":"Price filter for products equals to particular amount","schema":{"type":"number","description":"Price filter for products equals to particular amount"}},{"name":"price[ne]","in":"query","required":false,"description":"Price filter for products not equals to particular amount","schema":{"type":"number","description":"Price filter for products not equals to particular amount"}},{"name":"categories","in":"query","required":false,"description":"Filter by product categories","schema":{"type":"array","description":"Filter by product categories"}},{"name":"modifiedSince","in":"query","required":false,"description":"Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…","schema":{"type":"string","description":"Filter (urlencoded) the orders modified after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in…"}},{"name":"createdSince","in":"query","required":false,"description":"Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time…","schema":{"type":"string","description":"Filter (urlencoded) the orders created after a given UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to pass your timezone in date-time…"}}],"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:brevo/ecommerce-create-product":{"post":{"operationId":"communication_brevo_ecommerce_create_product","summary":"Create/Update a product","description":"POST /products","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/ecommerce-get-product-details":{"get":{"operationId":"communication_brevo_ecommerce_get_product_details","summary":"Get a product's details","description":"GET /products/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Product ID","schema":{"type":"string","description":"Product 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:brevo/ecommerce-create-products-batch":{"post":{"operationId":"communication_brevo_ecommerce_create_products_batch","summary":"Create products in batch","description":"POST /products/batch","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/coupons-list-coupon-collections":{"get":{"operationId":"communication_brevo_coupons_list_coupon_collections","summary":"Get all your coupon collections","description":"GET /couponCollections","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page","schema":{"type":"integer","default":50,"description":"Number of documents returned per page"}},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page","schema":{"type":"integer","default":0,"description":"Index of the first document on the page"}},{"name":"sort","in":"query","required":false,"description":"Sort the results by creation time in ascending/descending order","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results by creation time in ascending/descending order"}},{"name":"sortBy","in":"query","required":false,"description":"The field used to sort coupon collections","schema":{"type":"string","enum":["createdAt","remainingCoupons","expirationDate"],"default":"createdAt","description":"The field used to sort coupon collections"}}],"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:brevo/coupons-create-collection":{"post":{"operationId":"communication_brevo_coupons_create_collection","summary":"Create а coupon collection","description":"POST /couponCollections","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/coupons-get-by-id":{"get":{"operationId":"communication_brevo_coupons_get_by_id","summary":"Get a coupon collection by id","description":"GET /couponCollections/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the collection to return","schema":{"type":"string","description":"Id of the collection to return"}}],"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:brevo/coupons-update-coupon-collection-by-id":{"post":{"operationId":"communication_brevo_coupons_update_coupon_collection_by_id","summary":"Update a coupon collection by id","description":"PATCH /couponCollections/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"Id of the collection to update"},"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:brevo/coupons-create-coupon-collection":{"post":{"operationId":"communication_brevo_coupons_create_coupon_collection","summary":"Create coupons for a coupon collection","description":"POST /coupons","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-whats-app-send-message":{"post":{"operationId":"communication_brevo_transactional_whats_app_send_message","summary":"Send a WhatsApp message","description":"POST /whatsapp/sendMessage","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/transactional-whats-app-get-activity":{"get":{"operationId":"communication_brevo_transactional_whats_app_get_activity","summary":"Get all your WhatsApp activity (unaggregated events)","description":"GET /whatsapp/statistics/events","tags":["communication"],"parameters":[{"name":"limit","in":"query","required":false,"description":"Number limitation for the result returned","schema":{"type":"integer","default":2500,"description":"Number limitation for the result returned"}},{"name":"offset","in":"query","required":false,"description":"Beginning point in the list to retrieve from","schema":{"type":"integer","default":0,"description":"Beginning point in the list to retrieve from"}},{"name":"startDate","in":"query","required":false,"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate","schema":{"type":"string","description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate"}},{"name":"endDate","in":"query","required":false,"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate","schema":{"type":"string","description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate"}},{"name":"days","in":"query","required":false,"description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_","schema":{"type":"integer","description":"Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_"}},{"name":"contactNumber","in":"query","required":false,"description":"Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)","schema":{"type":"string","description":"Filter results for specific contact (WhatsApp Number with country code. Example, 85264318721)"}},{"name":"event","in":"query","required":false,"description":"Filter the report for a specific event type","schema":{"type":"string","enum":["sent","delivered","read","error","unsubscribe","reply","soft-bounce"],"description":"Filter the report for a specific event type"}},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed"}}],"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:brevo/external-feeds-get-all-feeds":{"get":{"operationId":"communication_brevo_external_feeds_get_all_feeds","summary":"Fetch all external feeds","description":"GET /feeds","tags":["communication"],"parameters":[{"name":"search","in":"query","required":false,"description":"Can be used to filter records by search keyword on feed name","schema":{"type":"string","description":"Can be used to filter records by search keyword on feed name"},"example":"search"},{"name":"startDate","in":"query","required":false,"description":"Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than…","schema":{"type":"string","description":"Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Can be maximum 30 days older than…"},"example":"2022-09-04"},{"name":"endDate","in":"query","required":false,"description":"Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected…","schema":{"type":"string","description":"Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected…"},"example":"2022-10-01"},{"name":"sort","in":"query","required":false,"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed.","schema":{"type":"string","enum":["asc","desc"],"default":"desc","description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed."}},{"name":"authType","in":"query","required":false,"description":"Filter the records by `authType` of the feed.","schema":{"type":"string","enum":["basic","token","noAuth"],"description":"Filter the records by `authType` of the feed."}},{"name":"limit","in":"query","required":false,"description":"Number of documents returned per page.","schema":{"type":"integer","default":50,"description":"Number of documents returned per page."},"example":100},{"name":"offset","in":"query","required":false,"description":"Index of the first document on the page.","schema":{"type":"integer","default":0,"description":"Index of the first document on the page."},"example":0}],"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:brevo/external-feeds-create-feed":{"post":{"operationId":"communication_brevo_external_feeds_create_feed","summary":"Create an external feed","description":"POST /feeds","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/external-feeds-get-feed-by-uuid":{"get":{"operationId":"communication_brevo_external_feeds_get_feed_by_uuid","summary":"Get an external feed by UUID","description":"GET /feeds/{uuid}","tags":["communication"],"parameters":[{"name":"uuid","in":"query","required":true,"description":"UUID of the feed to fetch","schema":{"type":"string","description":"UUID of the feed to fetch"},"example":"38f351fb-6e77-4b38-979a-a2465260449e"}],"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:brevo/external-feeds-update-feed-by-uuid":{"post":{"operationId":"communication_brevo_external_feeds_update_feed_by_uuid","summary":"Update an external feed","description":"PUT /feeds/{uuid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid","body"],"properties":{"uuid":{"type":"string","description":"UUID of the feed to update"},"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:brevo/external-feeds-delete-feed-by-uuid":{"post":{"operationId":"communication_brevo_external_feeds_delete_feed_by_uuid","summary":"Delete an external feed","description":"DELETE /feeds/{uuid}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["uuid"],"properties":{"uuid":{"type":"string","description":"UUID of the feed to delete"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/payments-create-payment-request":{"post":{"operationId":"communication_brevo_payments_create_payment_request","summary":"Create a payment request","description":"POST /payments/requests","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/communication:brevo/payments-get-details":{"get":{"operationId":"communication_brevo_payments_get_details","summary":"Get payment request details","description":"GET /payments/requests/{id}","tags":["communication"],"parameters":[{"name":"id","in":"query","required":true,"description":"Id of the payment Request","schema":{"type":"string","description":"Id of the payment Request"},"example":"050db7b0-9bb7-4c1e-9c68-5a8dace8c1dc"}],"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:brevo/payments-delete-request":{"post":{"operationId":"communication_brevo_payments_delete_request","summary":"Delete a payment request.","description":"DELETE /payments/requests/{id}","tags":["communication"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["id"],"properties":{"id":{"type":"string","description":"ID of the payment request."}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}