Brevo MCP Server

openapi: 3.0.0 info: title: Brevo description: >- # Welcome 👋 Using the REST API allows you to programmatically execute a wide range of code operations which are also available through the user interface. In this guide you will find a quick start section with the most important concepts about the API, instructions to authenticate and some short code examples. ## **Quick start** There are a few [key concepts](https://developers.sendinblue.com/docs/how-it-works) to keep in mind while using our API: - [**Rate limits**](https://developers.sendinblue.com/docs/api-limits) **and** [**platform quotas**](https://developers.sendinblue.com/docs/platform-quotas) - How to call the [**endpoints**](https://developers.sendinblue.com/docs/how-it-works#endpoints) - What is the [**response structure**](https://developers.sendinblue.com/docs/how-it-works#responses) - What [**API SDKs**](https://developers.sendinblue.com/docs/api-clients) you can use depending on your stack - What [**IP addresses**](https://developers.sendinblue.com/docs/how-it-works#sendinblue-ip-addresses) we use [**Read more about how the API works**](https://developers.sendinblue.com/docs/how-it-works) **📖** version: 1.0.0 servers: - url: http://{{baseurl}} - url: https://api.sendinblue.com - url: https://in-automate.sendinblue.com components: securitySchemes: apikeyAuth: type: http scheme: apikey security: - apikeyAuth: [] tags: - name: Transactional description: >- Benefit from transactional sending in our different channels. Email, SMS, WhatsApp. - name: Transactional > Email API - name: Transactional > Templates - name: Transactional > Statistics - name: Transactional > Blocked Contacts - name: Transactional > Blocked Domains - name: Transactional > Logs - name: Transactional > Inbound Email Parsing - name: Transactional > Transactional SMS - name: Transactional > SMS statistics - name: Transactional > WhatsApp Transactional description: "WhatsApp Transactional helps you send one time messages to your customers seamlessly, such as order confirmations, status updates or password reset links. You can check out the API reference for WhatsApp Transactional at\_[API Reference > WhatsApp.](https://developers.sendinblue.com/reference/getwhatsappcampaign)\n\n## Requirements\n\nTo create and manage your WhatsApp messages you need to have access to the Sendinblue WhatsApp platform. If you have not already activated the WhatsApp platform on your account you can go to\_[WhatsApp Campaigns > Activating WhatsApp Campaigns.](https://developers.sendinblue.com/docs/activating-whatsapp-campaigns)\n\nSee more details in our dedicated guide [here](https://developers.sendinblue.com/docs/whatsapp-messages)." - name: Marketing description: >- Manage , schedule and trigger your email, SMS and WhatsApp campaigns. Within this collection you can also fetch statistics for all your marketing operations. - name: Marketing > Email Campaigns - name: Marketing > SMS Campaigns - name: Marketing > WhatsApp Campaigns description: "Here you will find an overview of the WhatsApp Campaigns API. Currently, the actions available are fetching details of your WhatsApp campaigns or you can delete a WhatsApp campaign through the endpoints. You can check the endpoints on the Sendinblue API reference site at\_[API Reference > WhatsApp campaigns.](https://developers.sendinblue.com/reference/getwhatsappcampaign)\n\n## Requirements\n\nTo create and manage your Whatsapp campaigns you need to have access to the WhatsApp Campaigns app. If you have not already activated the WhatsApp platform on your account you can go to\_[Whatsapp Campaigns > Activating WhatsApp Campaigns.](https://developers.sendinblue.com/docs/activating-whatsapp-campaigns)\n\nYou can learn more in this [dedicated guide.](https://developers.sendinblue.com/docs/whatsapp-campaigns-1)" - name: Contact management description: >- This collection contains the services to create bulk updates to contacts, create data import jobs, organize and segment your lists, among others. - name: Contact management > Contacts - name: Contact management > Folders - name: Contact management > Lists - name: Contact management > Attributes - name: Accounts and settings description: >- Under this collection you can manage multiple account specific objects such as: \-> Webhooks for Transactional events, Marketing events , Payments events and Inbound Parsing API events. \-> Reseller and Sub-accounts settings such as credit allocation , creation and deletion. \-> Track asynchronous processes being done for your account such as contact imports, ecommerce imports, data exports etc. \-> Get information about your plan and credits. - name: Accounts and settings > Webhooks - name: Accounts and settings > Reseller - name: Accounts and settings > Reseller > Credits - name: Accounts and settings > Reseller > IP management - name: Accounts and settings > Reseller > Domains - name: Accounts and settings > Reseller > Child accounts - name: Accounts and settings > Process - name: Accounts and settings > Corporate - name: Accounts and settings > Account data - name: Accounts and settings > Senders - name: Accounts and settings > Domains - name: Accounts and settings > User description: Invited Users Management - name: Sales CRM - name: Sales CRM > Companies - name: Sales CRM > Deals - name: Sales CRM > Tasks - name: Sales CRM > Notes - name: Sales CRM > Files - name: Conversations description: "With our comprehensive API offering, you can tailor Conversations to your needs:\n\n- The\_[**Javascript API**](https://developers.sendinblue.com/docs/javascript-api-reference)\_gives you full control over the chat widget. Read our guide on\_[customizing the chat widget](https://developers.sendinblue.com/docs/customize-the-widget)\_for use cases and explanations.\n- The\_[**REST API**](https://developers.sendinblue.com/docs/rest-api-reference)\_allows you to programmatically send, retrieve and manage chat messages, among other endpoints.\n- The\_[**webhooks**](https://developers.sendinblue.com/docs/conversations-webhooks)\_are for integrating Conversations with your system or other services, such as help desks." - name: Conversations > Messages - name: Conversations > Status - name: Conversations > Pushed messages - name: eCommerce description: "You can integrate your eCommerce shop with Sendinblue and benefit from great analytics and extended segmentation capabilities.\_\n\n- Analyse your customer conversions in the dashboard from new and returning customers along with the metrics about your most purchased product.\n- Monitor specific metrics on your products like the amount of revenue you got from a key products etc.\n- Retention analysis for your customers. Understand how likely is for your customers to visit again your store.\n \n\n**For more details you can follow our eCommerce integration guide in the** [**Developers Portal**](https://developers.sendinblue.com/docs/import-your-products)." - name: eCommerce > Orders description: "You can manage your orders seamlessly through the eCommerce platform. You can see all the endpoints for eCommerce order management in the\_[API reference here.](https://developers.sendinblue.com/reference/post_ecommerce-activate)" - name: eCommerce > Categories description: >- After accessing the eCommerce platform you can start defining the categories that your products will be associated to. Note that this should ideally be the first object type you import into your account. - name: eCommerce > Products description: "After\_[importing your product categories](https://developers.sendinblue.com/reference/createupdatecategory)\_you can easily manage your product inventory through the following steps.\_\n\n## Requirements\n\nTo create and manage your eCommerce store products you need to have access to the Sendinblue eCommerce app. If you have not already activated the eCommerce platform on your account you can go to\_[eCommerce > Add the eCommerce App.](https://developers.sendinblue.com/reference/post_ecommerce-activate)" - name: Coupons - name: Events - name: Events > Automation Tracker paths: /smtp/email: post: tags: - Transactional > Email API summary: Send a transactional email requestBody: content: '*/*': schema: type: string example: >- "{\n \"sender\": {\n \"name\": \"Mary from MyShop\",\n \"email\": \"no-reply@myshop.com\"\n },\n \"to\": [\n {\n \"email\": \"jimmy98@example.com\",\n \"name\": \"Jimmy\"\n }\n ],\n \"bcc\": [\n {\n \"email\": \"helen9766@example.com\",\n \"name\": \"Helen\"\n },\n {\n \"email\": \"helen9766@example.com\",\n \"name\": \"Helen\"\n }\n ],\n \"cc\": [\n {\n \"email\": \"ann6533@example.com\",\n \"name\": \"Ann\"\n }\n ],\n \"htmlContent\": \"<!DOCTYPE html> <html> <body> <h1>This is sample HTML</h1> </html>\",\n \"subject\": \"Login Email confirmation\",\n \"replyTo\": {\n \"email\": \"ann6533@example.com\",\n \"name\": \"Ann\"\n },\n \"tags\": [\n \"tag1\",\n \"tag2\"\n ]\n}" parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: messageId: <201798300811.5787683@relay.domain.com> '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: messageId: <201798300811.5787683@relay.domain.com> '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path undefined: content: text/plain: schema: type: string example: null /smtp/emails: get: tags: - Transactional > Email API summary: Get the list of transactional emails on the basis of allowed filters description: >- This endpoint will show the list of emails for past 30 days by default. To retrieve emails before that time, please pass startDate and endDate in query filters. parameters: - name: Accept in: header schema: type: string example: application/json - name: email in: query 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 schema: type: string 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 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 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 selected is one month**. - name: endDate in: query 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 is one month.** - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc - name: limit in: query schema: type: integer description: Number of documents returned per page example: '500' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 120 transactionalEmails: - email: abc@xyz.com subject: summer camp templateId: 15 messageId: <201798300811.5787683@relay.domain.com> uuid: 5a78c-209ok98262910-std2341 date: '2019-05-25T11:53:26.000Z' - email: test@test.com subject: details verification templateId: 15 messageId: <201798300811.5700093@relay.domain.com> uuid: 5a78c-209ok98262910-s99a341 date: '2019-05-25T07:28:11.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/email/{identifier}: delete: tags: - Transactional > Email API summary: Delete scheduled emails by batchId or messageId description: >- Delete scheduled batch of emails by batchId or single scheduled email by messageId parameters: - name: Accept in: header schema: type: string example: application/json - name: identifier in: path schema: type: string required: true description: >- (Required) The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. example: 4320f270-a4e3-4a2e-b591-edfe30a5e627 responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/emails/{uuid}: get: tags: - Transactional > Email API summary: Get the personalized content of a sent transactional email parameters: - name: Accept in: header schema: type: string example: application/json - name: uuid in: path schema: type: string required: true description: >- (Required) Unique id of the transactional email that has been sent to a particular contact example: 4320f270-a4e3-4a2e-b591-edfe30a5e627 responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: email: abc@example.com subject: Summer Camps templateId: 12 date: '2016-02-25T11:53:26.000Z' events: - name: sent time: '2016-02-25T11:53:26.000Z' - name: delivered time: '2016-02-25T11:55:26.000Z' - name: opened time: '2016-02-26T09:53:26.000Z' body: >- <!DOCTYPE html> <html> <body> <h1>Greetings from the team</h1> <p>This is the actual html content sent</p> </body> </html> /smtp/emailStatus/{identifier}: get: tags: - Transactional > Email API summary: Fetch scheduled emails by batchId or messageId description: >- Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old) parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 date. example: '2022-02-02' - name: endDate in: query 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 is one month. example: '2022-03-02' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`. example: desc - name: status in: query schema: type: string description: >- Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`. example: queued - name: limit in: query schema: type: integer description: >- Number of documents returned per page. Not valid when identifier is `messageId`. example: '100' - name: offset in: query schema: type: integer description: >- Index of the first document on the page. Not valid when identifier is `messageId`. example: '0' - name: identifier in: path schema: type: string required: true description: >- (Required) The `batchId` of scheduled emails batch (Should be a valid UUIDv4) or the `messageId` of scheduled email. example: 4320f270-a4e3-4a2e-b591-edfe30a5e627 responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 3 batches: - scheduledAt: '2022-02-28T11:36:43.576000000Z' createdAt: '2022-02-26T11:36:43.576000000Z' status: queued - scheduledAt: '2022-02-25T11:36:43.576000000Z' createdAt: '2022-02-24T11:36:43.576000000Z' status: processed - scheduledAt: '2022-02-26T11:36:43.576000000Z' createdAt: '2022-02-25T11:36:43.576000000Z' status: inProgress '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/templates: get: tags: - Transactional > Templates summary: Get the list of email templates parameters: - name: Accept in: header schema: type: string example: application/json - name: templateStatus in: query schema: type: boolean description: >- Filter on the status of the template. Active = true, inactive = false example: 'false' - name: limit in: query schema: type: integer description: Number of documents returned per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 2 templates: - id: 5 name: ChristomasTimeTemplate subject: Merry Christmas isActive: false testSent: false sender: name: John email: john.smith@example.com id: 23 replyTo: replyto@domain.com toField: '' tag: Festival htmlContent: HTML CONTENT 1 createdAt: '2016-02-24T14:44:24.000Z' modifiedAt: '2016-02-24T15:37:11.000Z' - id: 12 name: SummerSales2017Template subject: Enjoy our summer Sales ! isActive: true testSent: false sender: name: John email: john.smith@example.com id: 23 replyTo: replyto@domain.com toField: '' tag: Summer htmlContent: HTML CONTENT 2 createdAt: '2016-02-25T11:53:26.000Z' modifiedAt: '2016-02-25T11:53:26.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Transactional > Templates summary: Create an email template requestBody: content: application/json: schema: type: object example: sender: name: Mary from MyShop email: contact@myshop.com id: 3 subject: Thanks for your purchase ! templateName: Order Confirmation - EN tag: OrderConfirmation htmlContent: The order n°xxxxx has been confirmed. Thanks for your purchase htmlUrl: https://html.domain.com replyTo: support@myshop.com toField: '{FNAME} {LNAME}' attachmentUrl: https://attachment.domain.com isActive: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/templates/{templateId}: get: tags: - Transactional > Templates summary: Returns the template information parameters: - name: Accept in: header schema: type: string example: application/json - name: templateId in: path schema: type: integer required: true description: (Required) id of the template example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 33 name: OrderConfirmation subject: 'Order Confirmation : Thanks for your Purchase !' isActive: true testSent: false sender: name: John email: john.smith@example.com id: 26 replyTo: replyto@domain.com toField: '' tag: '' htmlContent: HTML CONTENT 4 createdAt: '2016-02-25T11:53:26.000Z' modifiedAt: '2016-02-25T11:53:26.000Z' doiTemplate: false '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Transactional > Templates summary: Update an email template requestBody: content: application/json: schema: type: object example: tag: OrderConfirmation sender: name: Mary from MyShop email: contact@myshop.com id: 3 templateName: Order Confirmation - EN htmlContent: The order n°xxxxx has been confirmed. Thanks for your purchase htmlUrl: https://html.domain.com subject: Thanks for your purchase ! replyTo: support@myshop.com toField: '{FNAME} {LNAME}' attachmentUrl: https://attachment.domain.com isActive: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: templateId in: path schema: type: integer required: true description: (Required) id of the template example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Transactional > Templates summary: Delete an inactive email template parameters: - name: Accept in: header schema: type: string example: application/json - name: templateId in: path schema: type: integer required: true description: (Required) id of the template example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/templates/{templateId}/sendTest: post: tags: - Transactional > Templates summary: Send a template to your test list requestBody: content: application/json: schema: type: object example: emailTo: - helen.jurger@example.com - helen.jurger@example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: templateId in: path schema: type: integer required: true description: (Required) Id of the template example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: The email could not be sent to all recipients unexistingEmails: - XUvXs2MUkZy@eNdDZoaehFi.etn - HnrmUyMYn@sfTjWkSBpk.hm withoutListEmails: - qSPfAA-ZR9R@CdCUpePDRUIlyeX.js - hoJRuR3l@MHrCixtPTEHuYek.hs blackListedEmails: - wjSlx1vUDTsWt5@SzwzihE.ot - LO4E3a@ycxq.ri '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/statistics/aggregatedReport: get: tags: - Transactional > Statistics summary: Get your transactional email activity aggregated over a period of time description: >- This endpoint will show the aggregated stats for past 90 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 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 schema: type: integer description: > Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ example: '7' - name: tag in: query schema: type: string description: Tag of the emails responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: range: 2016-09-08|2017-04-28 requests: 19887 delivered: 18996 hardBounces: 234 softBounces: 1533 clicks: 9987 uniqueClicks: 8766 opens: 17654 uniqueOpens: 13688 spamReports: 1 blocked: 2 invalid: 0 unsubscribed: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/statistics/reports: get: tags: - Transactional > Statistics summary: Get your transactional email activity aggregated per day parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents returned per page example: '10' - name: offset in: query schema: type: integer description: Index of the first document on the page example: '0' - name: startDate in: query schema: type: string description: > **Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD) - name: endDate in: query schema: type: string description: > **Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD) - name: days in: query schema: type: integer description: > Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ example: '7' - name: tag in: query schema: type: string description: Tag of the emails - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: reports: - date: '2017-04-30T00:00:00.000Z' requests: 10756 delivered: 10103 hardBounces: 21 softBounces: 137 clicks: 1026 uniqueClicks: 720 opens: 5091 uniqueOpens: 2318 spamReports: 0 blocked: 519 invalid: 1 unsubscribed: 0 - date: '2017-05-01T00:00:00.000Z' requests: 18812 delivered: 17499 hardBounces: 34 softBounces: 254 clicks: 1514 uniqueClicks: 1090 opens: 10089 uniqueOpens: 4393 spamReports: 0 blocked: 920 invalid: 2 unsubscribed: 3 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /v3/smtp/statistics/events: get: tags: - Transactional > Statistics summary: Get all your transactional email activity (unaggregated events) description: >- This endpoint will show the aggregated stats for past 30 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 90 days security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: days in: query schema: type: integer description: > Number of days in the past including today (positive integer). _Not compatible with 'startDate' and 'endDate'_ example: '11' - name: messageId in: query schema: type: string description: Filter on a specific message id example: 202212281024.62341432715@smtp-relay.mailin.fr responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: events: - email: john.smith@example.com date: '2017-03-12T12:30:00.000Z' messageId: <201798300811.5787683@example.domain.com> event: deferred reason: Error connection timeout tag: OrderConfirmation from: john@example.com templateId: 4 - email: john.smith@example.com date: '2017-03-13T16:30:00.000Z' messageId: <201798300811.5787683@example.domain.com> event: delivered tag: OrderConfirmation from: john@example.com templateId: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/blockedContacts: get: tags: - Transactional > Blocked Contacts summary: Get the list of blocked or unsubscribed transactional contacts parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 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 schema: type: integer description: Number of documents returned per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document on the page example: '0' - name: senders in: query schema: type: string description: >- Comma separated list of emails of the senders from which contacts are blocked or unsubscribed - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 1 contacts: - email: abc@xyz.com senderEmail: ez312@gmal.com reason: message: Admin blocked code: adminBlocked blockedAt: '2017-05-01T12:30:00.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/blockedContacts/{email}: delete: tags: - Transactional > Blocked Contacts summary: Unblock or resubscribe a transactional contact parameters: - name: Accept in: header schema: type: string example: application/json - name: email in: path schema: type: string required: true description: (Required) contact email (urlencoded) to unblock. example: example@domain.com responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/blockedDomains: get: tags: - Transactional > Blocked Domains summary: Get the list of blocked domains description: Get the list of blocked domains parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: domains: - example.com - testdomain.com post: tags: - Transactional > Blocked Domains summary: Add a new domain to the list of blocked domains description: Blocks a new domain in order to avoid messages being sent to the same requestBody: content: application/json: schema: type: object example: domain: example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/blockedDomains/{domain}: delete: tags: - Transactional > Blocked Domains summary: Unblock an existing domain from the list of blocked domains description: Unblocks an existing domain from the list of blocked domains parameters: - name: Accept in: header schema: type: string example: application/json - name: domain in: path schema: type: string required: true description: (Required) The name of the domain to be deleted example: domain.com responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/deleteHardbounces: post: tags: - Transactional > Logs summary: Delete hardbounces description: >- Delete hardbounces. To use carefully (e.g. in case of temporary ISP failures) requestBody: content: application/json: schema: type: object example: startDate: nostrud magna endDate: incididunt contactEmail: alex76@example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smtp/log/{messageId}: delete: tags: - Transactional > Logs summary: Delete an SMTP transactional log parameters: - name: Accept in: header schema: type: string example: application/json - name: messageId in: path schema: type: string required: true description: (Required) MessageId of the transactional log to delete example: 235614243234124@mailin.fr responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /inbound/events: get: tags: - Transactional > Inbound Email Parsing summary: Get the list of all the events for the received emails. description: >- This endpoint will show the list of all the events for the received emails. parameters: - name: Accept in: header schema: type: string example: application/json - name: sender in: query schema: type: string description: Email address of the sender. - name: startDate in: query 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 selected is one month. example: '1947-08-13' - name: endDate in: query 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 is one month. example: '1947-08-13' - name: limit in: query schema: type: integer description: Number of documents returned per page example: '100' - name: offset in: query schema: type: integer description: Index of the first document on the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: events: - uuid: 1a825d56-029b-4a41-b8e4-1a825d56 date: '2017-03-11T12:30:00.000Z' sender: john@example.com recipient: alexa@example.com - uuid: 1a825d56-029b-4a41-b8e4-61670463431b date: '2017-03-12T12:30:00.000Z' sender: alice@example.com recipient: bob@example.com '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /inbound/events/{uuid}: get: tags: - Transactional > Inbound Email Parsing summary: Fetch all events history for one particular received email. description: >- This endpoint will show the list of all events history for one particular received email. parameters: - name: Accept in: header schema: type: string example: application/json - name: uuid in: path schema: type: string required: true description: (Required) UUID to fetch events specific to recieved email responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: receivedAt: '2017-03-12T12:30:00.000Z' deliveredAt: '2017-03-12T12:31:00.000Z' sender: alice@example.com recipient: bob@example.com messageId: <a_nice@message.id> subject: 'Re: Question about your API' attachments: - name: invoice.pdf contentType: application/pdf contentId: null contentLength: 12345 logs: - date: '2017-03-12T12:30:00.000Z' type: received - date: '2017-03-12T12:30:04.000Z' type: webhookFailed - date: '2017-03-12T12:31:04.000Z' type: webhookDelivered '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /inbound/attachments/{downloadToken}: get: tags: - Transactional > Inbound Email Parsing summary: Retrieve inbound attachment with download token. description: This endpoint will retrieve inbound attachment with download token. parameters: - name: Accept in: header schema: type: string example: application/octet-stream - name: downloadToken in: path schema: type: string required: true description: (Required) Token to fetch a particular attachment responses: '200': description: OK headers: Content-Disposition: schema: type: string example: attachment; filename="download.png" Content-Length: schema: type: integer example: '4032' Content-Type: schema: type: string example: application/octet-stream content: text/plain: schema: type: string example: veniam elit in '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /transactionalSMS/sms: post: tags: - Transactional > Transactional SMS summary: Send SMS message to a mobile number requestBody: content: application/json: schema: type: object example: content: Enter this code:CCJJG8 to validate your account recipient: '33689965433' sender: MyShop type: marketing tag: accountValidation webUrl: http://requestb.in/173lyyx1 unicodeEnabled: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: messageId: 1511882900176220 reference: ab1cde2fgh3i4jklmno smsCount: 2 usedCredits: 0.7 remainingCredits: 82.85 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '402': description: Payment Required headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /transactionalSMS/statistics/aggregatedReport: get: tags: - Transactional > SMS statistics summary: Get your SMS activity aggregated over a period of time parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query schema: type: string description: > **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report - name: endDate in: query schema: type: string description: > **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report - name: days in: query schema: type: integer description: > Number of days in the past including today (positive integer). **Not compatible with startDate and endDate** example: '7' - name: tag in: query schema: type: string description: Filter on a tag responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: range: 2015-05-22|2017-11-29 requests: 54 delivered: 16 hardBounces: 5 softBounces: 26 blocked: 4 unsubscribed: 10 replied: 8 accepted: 6 rejected: 14 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /transactionalSMS/statistics/reports: get: tags: - Transactional > SMS statistics summary: Get your SMS activity aggregated per day parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query schema: type: string description: > **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report - name: endDate in: query schema: type: string description: > **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report - name: days in: query schema: type: integer description: > Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'** example: '7' - name: tag in: query schema: type: string description: Filter on a tag - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: reports: - date: '2017-04-30T00:00:00.000Z' requests: 10756 delivered: 10103 hardBounces: 21 softBounces: 137 blocked: 1026 unsubscribed: 720 replied: 5091 accepted: 2318 rejected: 0 - date: '2017-05-01T00:00:00.000Z' requests: 18812 delivered: 17499 hardBounces: 34 softBounces: 254 blocked: 1514 unsubscribed: 1090 replied: 10089 accepted: 4393 rejected: 0 - date: '2017-05-02T00:00:00.000Z' requests: 14321 delivered: 13427 hardBounces: 16 softBounces: 176 blocked: 1646 unsubscribed: 1170 replied: 11563 accepted: 4689 rejected: 0 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /transactionalSMS/statistics/events: get: tags: - Transactional > SMS statistics summary: Get all your SMS activity (unaggregated events) parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: startDate in: query schema: type: string description: > **Mandatory if endDate is used.** Starting date (YYYY-MM-DD) of the report - name: endDate in: query schema: type: string description: > **Mandatory if startDate is used.** Ending date (YYYY-MM-DD) of the report - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: days in: query schema: type: integer description: > Number of days in the past including today (positive integer). **Not compatible with 'startDate' and 'endDate'** example: '7' - name: phoneNumber in: query schema: type: string description: Filter the report for a specific phone number - name: event in: query schema: type: string description: Filter the report for specific events example: bounces - name: tags in: query schema: type: string description: >- Filter the report for specific tags passed as a serialized urlencoded array - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: events: - phoneNumber: '00911059469013' date: '2015-05-20T12:30:00.000Z' messageId: '1473139351170140' event: sent reason: Recipient is currently unreachable tag: cabWaiting - phoneNumber: '00911059469013' date: '2015-05-20T16:30:00.000Z' messageId: '1473139351170140' event: delivered reason: Recipient is currently unreachable tag: cabRequest '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /v3/whatsapp/sendMessage: post: tags: - Transactional > WhatsApp Transactional summary: Send a WhatsApp message requestBody: content: application/json: schema: type: object example: contactNumbers: - '919808240608' senderNumber: '919900751564' xtext: saranghe templateId: 744919760309407 responses: '201': description: Created headers: content-length: schema: type: integer example: '53' content-type: schema: type: string example: application/json date: schema: type: string example: Fri, 27 Jan 2023 13:16:59 GMT content: application/json: schema: type: object example: messageId: 5b0d880b-b258-4c9c-a31b-1e248d11d66c /v3/whatsapp/statistics/events: get: tags: - Transactional > WhatsApp Transactional summary: Get all your WhatsApp activity (unaggregated events) Copy parameters: - name: limit in: query schema: type: integer example: '1' - name: offset in: query schema: type: integer example: '9' - name: event in: query schema: type: string example: sent - name: startDate in: query schema: type: string - name: endDate in: query schema: type: string - name: sort in: query schema: type: string example: desc - name: contactNumber in: query schema: type: integer example: '918077039164' - name: days in: query schema: type: integer example: '3' responses: '200': description: OK headers: Date: schema: type: string example: Wed, 22 Feb 2023 07:13:22 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive CF-Ray: schema: type: string example: 79d5eb2e9cfc33c6-DEL Access-Control-Allow-Origin: schema: type: string example: '*' CF-Cache-Status: schema: type: string example: DYNAMIC access-control-allow-credentials: schema: type: boolean example: 'true' access-control-allow-headers: schema: type: string example: '*' access-control-allow-methods: schema: type: string example: PUT, POST, GET, DELETE, PATCH, OPTIONS cf-apo-via: schema: type: string example: origin,host sib-request-id: schema: type: string example: 626c8458-1def-94cd-8cef-89894e1e5969 x-envoy-upstream-service-time: schema: type: integer example: '43' Server-Timing: schema: type: string example: cf-q-config;dur=6.9999987317715e-06 Vary: schema: type: string example: Accept-Encoding Server: schema: type: string example: cloudflare Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: events: - senderNumber: '9368207022' contactNumber: '916666666666' event: soft-bounce messageId: '43:18' date: '2023-02-16T11:38:09.395+01:00' - senderNumber: '9368207022' contactNumber: '916666666666' event: soft-bounce messageId: '43:22' date: '2023-02-16T11:38:09.395+01:00' - senderNumber: '9368207022' contactNumber: '916666666666' event: soft-bounce messageId: '43:20' date: '2023-02-16T11:38:08.139+01:00' - senderNumber: '9368207022' contactNumber: '916666666666' event: soft-bounce messageId: '43:16' date: '2023-02-16T11:38:08.139+01:00' - senderNumber: '9368207022' contactNumber: '916666666666' event: soft-bounce messageId: '30:2' date: '2023-01-30T13:51:31.263+01:00' /emailCampaigns/{campaignId}: get: tags: - Marketing > Email Campaigns summary: Get an email campaign report parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '13396752' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 22 name: Weekly - 1 subject: Week 1 - Newsletter type: classic status: draft scheduledAt: '2017-09-22T12:30:00.000Z' testSent: false header: '[DEFAULT_HEADER]' footer: '[DEFAULT_FOOTER]' sender: email: newsletter@mycompany.com name: Newsletter id: 26 replyTo: replyto@domain.com toField: '{FNAME} {LNAME}' htmlContent: This is my HTML Content shareLink: http://dhh.sendinblue.com/fhsgccc.html?t=9865448900 tag: Newsletter createdAt: '2017-05-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' inlineImageActivation: true mirrorActive: true recurring: false recipients: lists: - 22 exclusionLists: - 45 statistics: globalStats: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 trackableViewsRate: 23.45 estimatedViews: 560 unsubscriptions: 2 viewed: 8999 campaignStats: - listId: 22 uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 unsubscriptions: 2 viewed: 8999 deferred: 30 mirrorClick: 120 remaining: 1000 linksStats: http://myUrl1.domain.com: nbClick: 80 http://myUrl2.domain.com: nbClick: 80 http://myUrl3.domain.com: nbClick: 80 statsByDomain: gmail: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 unsubscriptions: 2 viewed: 8999 deferred: 30 statsByDevice: desktop: mac: clickers: 1 uniqueClicks: 0 viewed: 2 uniqueViews: 1 mobile: androidMobile: clickers: 1 uniqueClicks: 0 viewed: 1 uniqueViews: 0 iPhone: clickers: 1 uniqueClicks: 0 viewed: 2 uniqueViews: 0 statsByBrowser: thunderbird: clickers: 1 uniqueClicks: 0 viewed: 1 uniqueViews: 0 safari: clickers: 1 uniqueClicks: 0 viewed: 1 uniqueViews: 0 internetExplorer: clickers: 0 uniqueClicks: 0 viewed: 1 uniqueViews: 0 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Marketing > Email Campaigns summary: Update an email campaign requestBody: content: application/json: schema: type: object example: tag: Newsletter sender: name: Summer Deals email: newsletter@myshop.com id: 3 name: Newsletter - May 2023 htmlContent: >- <!DOCTYPE html> <html> <body> <h1>Hot summer deals have just dropped</h1> <p>Hit the link below to see what's new!</p> </body> </html> htmlUrl: https://html.domain.com scheduledAt: ipsum subject: Discover the New Collection ! replyTo: support@myshop.com toField: '{FNAME} {LNAME}' recipients: exclusionListIds: - 8 - 8 listIds: - 32 - 32 attachmentUrl: https://attachment.domain.com inlineImageActivation: true mirrorActive: true recurring: false footer: '[DEFAULT_FOOTER]' header: '[DEFAULT_HEADER]' utmCampaign: NL_05_2017 params: {} sendAtBestTime: true abTesting: true subjectA: Discover the New Collection! subjectB: Want to discover the New Collection? splitRule: 50 winnerCriteria: open winnerDelay: 50 ipWarmupEnable: true initialQuota: 3000 increaseRate: 70 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Marketing > Email Campaigns summary: Delete an email campaign parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the campaign example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/sendNow: post: tags: - Marketing > Email Campaigns summary: Send an email campaign immediately, based on campaignId requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '402': description: Payment Required headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/sendTest: post: tags: - Marketing > Email Campaigns summary: Send an email campaign to your test list requestBody: content: application/json: schema: type: object example: emailTo: - helen.jurger@example.com - helen.jurger2@example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: The email could not be sent to all recipients unexistingEmails: - 75BfS6kLq8tM@SJimzZAEpYHRyLStQjY.gxs - 5raZtMVhzx@gMjdaabGzAjkYrK.fnco withoutListEmails: - 3j0Dt@VghDwawjVvNTjFVmRKWJ.agyu - UaS0Xey-oMdkd@vZKiBhSUbOueTWIJZpFdJmnF.ug blackListedEmails: - jooW@GLWhkVFSczNd.qgrn - K0YvNXk7f@tETerPDdjJVYYwNPbKs.pur '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: The email could not be sent to all recipients unexistingEmails: - XUvXs2MUkZy@eNdDZoaehFi.etn - HnrmUyMYn@sfTjWkSBpk.hm withoutListEmails: - qSPfAA-ZR9R@CdCUpePDRUIlyeX.js - hoJRuR3l@MHrCixtPTEHuYek.hs blackListedEmails: - wjSlx1vUDTsWt5@SzwzihE.ot - LO4E3a@ycxq.ri /emailCampaigns/{campaignId}/status: put: tags: - Marketing > Email Campaigns summary: Update an email campaign status requestBody: content: application/json: schema: type: object example: status: suspended parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '3' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/sendReport: post: tags: - Marketing > Email Campaigns summary: Send the report of a campaign description: A PDF will be sent to the specified email addresses requestBody: content: application/json: schema: type: object example: email: body: Please find attached the report of our last email campaign. to: - jim.suehan@example.com - jim.suehan@example.com language: en parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/abTestCampaignResult: get: tags: - Marketing > Email Campaigns summary: Get an A/B test email campaign results description: Obtain winning version of an A/B test email campaign parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the A/B test campaign example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: winningVersion: B winningCriteria: Click openRate: 100% clickRate: 50% winningVersionRate: 0% statistics: openers: Version A: 20% Version B: 100% clicks: Version A: 0% Version B: 50% unsubscribed: Version A: 20% Version B: 0% softBounces: Version A: 0% Version B: 0% hardBounces: Version A: 0% Version B: 0% complaints: Version A: 0% Version B: 0% clickedLinks: Version A: - link: https://google.com clicksCount: 0 clickRate: 0% - link: https://youtube.com clicksCount: 0 clickRate: 0% Version B: - link: http://www.github.com clicksCount: 2 clickRate: 40% - link: http://www.stackoverflow.com clicksCount: 3 clickRate: 60% '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/sharedUrl: get: tags: - Marketing > Email Campaigns summary: Get a shared template url description: >- Get a unique URL to share & import an email template from one Sendinblue account to another. parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign or template example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: sharedUrl: >- https://my.sendinblue.com/pt2YU7R5W_guXlowgumy_VX4pFsKu._zd0Gjj96x1_GMmzc1Qps5ZIpj6nx- '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '405': description: Method Not Allowed headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/{campaignId}/exportRecipients: post: tags: - Marketing > Email Campaigns summary: Export the recipients of an email campaign requestBody: content: application/json: schema: type: object example: recipientsType: openers notifyURL: http://requestb.in/173lyyx1 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the campaign example: '13396752' responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: processId: 78 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns: get: tags: - Marketing > Email Campaigns summary: Return all your created email campaigns parameters: - name: Accept in: header schema: type: string example: application/json - name: type in: query schema: type: string description: Filter on the type of the campaigns - name: status in: query schema: type: string description: Filter on the status of the campaign - name: startDate in: query 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. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) - name: endDate in: query 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. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 2 campaigns: - id: 12 name: EN - Sales Summer 2017 subject: 20% OFF for 2017 Summer Sales type: classic status: sent scheduledAt: '2017-06-01T12:30:00.000Z' testSent: true header: '[DEFAULT_HEADER]' footer: '[DEFAULT_FOOTER]' sender: email: marketing@mycompany.com name: Marketing id: 26 replyTo: replyto@domain.com toField: '{FNAME} {LNAME}' htmlContent: This is my HTML Content shareLink: http://example.com/fhsgccc.html?t=9865448900 tag: Newsletter createdAt: '2017-05-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' inlineImageActivation: true mirrorActive: true recurring: false recipients: lists: - 5 exclusionLists: - 13 statistics: globalStats: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 trackableViewsRate: 23.45 estimatedViews: 560 unsubscriptions: 2 viewed: 8999 campaignStats: - listId: 5 uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 unsubscriptions: 2 viewed: 8999 deferred: 30 mirrorClick: 120 remaining: 1000 linksStats: http://myUrl1.domain.com: 80 statsByDomain: yahoo.com: uniqueClicks: 298 clickers: 533 complaints: 0 sent: 25601 softBounces: 5 hardBounces: 0 uniqueViews: 3527 unsubscriptions: 17 viewed: 5255 delivered: 25596 hotmail.co.uk: uniqueClicks: 1970 clickers: 2720 complaints: 5 sent: 117055 softBounces: 111 hardBounces: 0 uniqueViews: 21111 unsubscriptions: 105 viewed: 35251 delivered: 117056 - id: 22 name: Weekly - 1 subject: Week 1 - Newsletter type: Classic status: draft scheduledAt: '' testSent: false header: '[DEFAULT_HEADER]' footer: '[DEFAULT_FOOTER]' sender: email: newsletter@mycompany.com name: Newsletter id: 26 replyTo: replyto@domain.com toField: '{FNAME} {LNAME}' htmlContent: This is my HTML Content shareLink: http://example.com/fhsgccc.html?t=9865448900 tag: Newsletter createdAt: '2017-05-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' inlineImageActivation: true mirrorActive: true recurring: false recipients: lists: - 10 exclusionLists: - 45 statistics: globalStats: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 trackableViewsRate: 23.45 estimatedViews: 560 unsubscriptions: 2 viewed: 8999 campaignStats: - listId: 10 uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 trackableViews: 5661 unsubscriptions: 2 viewed: 8999 deferred: 30 mirrorClick: 120 remaining: 1000 linksStats: http://myUrl1.domain.com: nbClick: 80 http://myUrl2.domain.com: nbClick: 80 http://myUrl3.domain.com: nbClick: 80 statsByDomain: gmail: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 unsubscriptions: 2 viewed: 8999 deferred: 30 aol: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 unsubscriptions: 2 viewed: 8999 deferred: 30 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Marketing > Email Campaigns summary: Create an email campaign requestBody: content: application/json: schema: type: object example: name: Newsletter - May 2017 sender: name: Mary from MyShop email: newsletter@myshop.com id: 3 tag: Newsletter htmlContent: >- <!DOCTYPE html> <html> <body> <h1>Confirm you email</h1> <p>Please confirm your email address by clicking on the link below</p> </body> </html> htmlUrl: https://html.domain.com templateId: 71900287 scheduledAt: Excepteur molli subject: Discover the New Collection ! replyTo: support@myshop.com toField: '{FNAME} {LNAME}' recipients: exclusionListIds: - 8 - 8 listIds: - 32 - 32 attachmentUrl: https://attachment.domain.com inlineImageActivation: true mirrorActive: true footer: '[DEFAULT_FOOTER]' header: '[DEFAULT_HEADER]' utmCampaign: NL_05_2017 params: veniam_8: {} nullac: {} cillum3c: {} sendAtBestTime: true abTesting: true subjectA: Discover the New Collection! subjectB: Want to discover the New Collection? splitRule: 50 winnerCriteria: open winnerDelay: 50 ipWarmupEnable: true initialQuota: 3000 increaseRate: 70 unsubscriptionPageId: 62cbb7fabbe85021021aac52 updateFormId: 6313436b9ad40e23b371d095 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /emailCampaigns/images: post: tags: - Marketing > Email Campaigns summary: Upload an image to your account's image gallery requestBody: content: application/json: schema: type: object example: imageUrl: https://somedomain.com/image1.jpg name: nature.jpg parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: url: >- https://img.mailinblue.com/100000/images/rnb/original/62casdase8wewq9df1c2f27c.jpeg '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns: get: tags: - Marketing > SMS Campaigns summary: Returns the information for all your created SMS campaigns parameters: - name: Accept in: header schema: type: string example: application/json - name: status in: query schema: type: string description: Status of campaign. example: archive - name: startDate in: query 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. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) - name: endDate in: query 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. **Prefer to pass your timezone in date-time format for accurate result** ( only available if either 'status' not passed and if passed is set to 'sent' ) - name: limit in: query schema: type: integer description: Number limitation for the result returned example: '500' - name: offset in: query schema: type: integer description: Beginning point in the list to retrieve from. example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: campaigns: - id: 2 name: PROMO CODE status: sent content: Visit our Store and get some discount ! scheduledAt: '2017-06-01T12:30:00.000Z' testSent: true sender: MyCompany createdAt: '2017-06-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' sentDate: '2017-06-01T12:30:00.000Z' recipients: lists: - 21 exclusionLists: - 13 statistics: delivered: 2987 sent: 3000 processing: 0 softBounces: 3 hardBounces: 1 unsubscriptions: 3 answered: 2 - id: 10 name: SUMMER SALE status: draft content: >- Summer Sale is starting tomorrow. Get extra 10% with this code:SUM17 scheduledAt: '2017-08-04T12:30:00.000Z' testSent: false sender: MyCompany createdAt: '2017-06-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' sentDate: '2017-06-01T12:30:00.000Z' recipients: lists: - 21 exclusionLists: - 13 statistics: delivered: 2987 sent: 3000 processing: 0 softBounces: 3 hardBounces: 1 unsubscriptions: 3 answered: 2 count: 12 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Marketing > SMS Campaigns summary: Creates an SMS campaign requestBody: content: application/json: schema: type: object example: content: >- Get a discount by visiting our NY store and saying : Happy Spring! name: Spring Promo Code sender: MyShop recipients: listIds: - 54 - 54 exclusionListIds: - 15 - 15 scheduledAt: YYYY-MM-DDTHH:mm:ss.SSSZ unicodeEnabled: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}: get: tags: - Marketing > SMS Campaigns summary: Get an SMS campaign parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the SMS campaign example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 2 name: PROMO CODE status: sent content: Visit our Store and get some discount ! scheduledAt: '2017-06-01T12:30:00.000Z' testSent: true sender: MyCompany createdAt: '2017-06-01T12:30:00.000Z' modifiedAt: '2017-05-01T12:30:00.000Z' recipients: lists: - 21 exclusionLists: - 13 statistics: delivered: 2987 sent: 3000 processing: 0 softBounces: 3 hardBounces: 1 unsubscriptions: 3 answered: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Marketing > SMS Campaigns summary: Update an SMS campaign requestBody: content: application/json: schema: type: object example: name: Spring Promo Code sender: MyShop content: >- Get a discount by visiting our NY store and saying : Happy Spring! recipients: listIds: - 54 - 54 exclusionListIds: - 15 - 15 scheduledAt: irure deserunt mollit dolore unicodeEnabled: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the SMS campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Marketing > SMS Campaigns summary: Delete an SMS campaign parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the SMS campaign example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}/sendNow: post: tags: - Marketing > SMS Campaigns summary: Send your SMS campaign immediately requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '402': description: Payment Required headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}/status: put: tags: - Marketing > SMS Campaigns summary: Update a campaign's status requestBody: content: application/json: schema: type: object example: status: suspended parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}/sendTest: post: tags: - Marketing > SMS Campaigns summary: Send a test SMS campaign requestBody: content: application/json: schema: type: object example: phoneNumber: '33689965433' parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) Id of the SMS campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: The SMS could not be sent to all recipients unexistingSms: - uONf@iAiaZmhYWwGaKp.rtix - FYIHDS@aUQgXmyvqTgUDBWeTXsc.dh withoutListSms: - qRZAMI0KoD5@mIhThccLqX.qjn - CrFkHJl6Pz9bj@CkukdVNyAwyMdcvHBYDZ.vwf '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}/exportRecipients: post: tags: - Marketing > SMS Campaigns summary: Export an SMS campaign's recipients description: >- It returns the background process ID which on completion calls the notify URL that you have set in the input. requestBody: content: application/json: schema: type: object example: recipientsType: answered notifyURL: http://requestb.in/173lyyx1 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the campaign example: '13396752' responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: processId: 78 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /smsCampaigns/{campaignId}/sendReport: post: tags: - Marketing > SMS Campaigns summary: Send an SMS campaign's report description: >- Send report of Sent and Archived campaign, to the specified email addresses, with respective data and a pdf attachment in detail. requestBody: content: application/json: schema: type: object example: email: body: Please find attached the report of our last email campaign. to: - jim.suehan@example.com - jim.suehan@example.com language: en parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: campaignId in: path schema: type: integer required: true description: (Required) id of the campaign example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /whatsappCampaigns/: get: tags: - Marketing > WhatsApp Campaigns summary: Get a WhatsApp campaign parameters: - name: campaignId in: query schema: type: integer description: | Pass the identifier of the campaign to be retrieved. example: '12' responses: undefined: headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 1672035851100690 campaignName: Test Whatsapp Campaign campaignStatus: sent scheduledAt: '2022-12-26T09:50:00.000Z' senderNumber: 9368207029 recipients: type: list includedLists: - 22 excludedLists: - 45 template: name: official_campaign8 category: MARKETING language: en contains_button: true display_header: false components: - type: BODY text: making it look like readable English. - type: BUTTONS buttons: - type: URL text: vLorem Ipsum is simply du url: app.sendinblue - type: PHONE_NUMBER text: Lorem Ipsum is simply dum phone_number: '+918800613137' header_variables: - name: FIRSTNAME default: INVALID HEADER index: 1 datatype: text header_type: text body_variable: [] button_type: CALL_TO_ACTION header_footer: true stats: sent: 3, delivered: 3, read: 2, unsubscribe: 0, not_sent: 4 createdAt: '2022-12-26T06:50:00.000Z' modifiedAt: '2022-12-26T08:50:00.000Z' delete: tags: - Marketing > WhatsApp Campaigns summary: Delete a WhatsApp campaign parameters: - name: campaignId in: query schema: type: integer example: '12' responses: '200': description: Successful response content: application/json: {} /whatsappCampaigns: get: tags: - Marketing > WhatsApp Campaigns summary: Return all your created WhatsApp campaigns parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query schema: type: string description: > **Mandatory if endDate is used**. Starting (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** - name: endDate in: query schema: type: string description: > **Mandatory if startDate is used**. Ending (urlencoded) UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created. **Prefer to pass your timezone in date-time format for accurate result** - name: limit in: query schema: type: string description: Number of documents per page - name: offset in: query schema: type: string description: Index of the first document in the page - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: campaigns: - id: <long> campaignName: <string> campaignStatus: <string> templateId: <string> scheduledAt: <string> createdAt: <string> modifiedAt: <string> errorReason: <string> invalidatedContacts: <long> readPercentage: <float> stats: sent: <integer> delivered: <integer> read: <integer> unsubscribe: <integer> notSent: <integer> - id: <long> campaignName: <string> campaignStatus: <string> templateId: <string> scheduledAt: <string> createdAt: <string> modifiedAt: <string> errorReason: <string> invalidatedContacts: <long> readPercentage: <float> stats: sent: <integer> delivered: <integer> read: <integer> unsubscribe: <integer> notSent: <integer> count: <long> '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: <string> message: <string> post: tags: - Marketing > WhatsApp Campaigns summary: Create and send a WhatsApp campaign requestBody: content: '*/*': schema: type: string example: '""' parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /whatsappCampaigns/template-list: get: tags: - Marketing > WhatsApp Campaigns summary: Return all your created WhatsApp templates parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 to pass your timezone in date-time format for accurate result** - name: endDate in: query 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 to pass your timezone in date-time format for accurate result** - name: limit in: query schema: type: string description: Number of documents per page - name: offset in: query schema: type: string description: Index of the first document in the page - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record modification. Default order is **descending** if `sort` is not passed responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: templates: - id: <string> name: <string> status: <string> category: <string> language: <string> createdAt: <string> modifiedAt: <string> errorReason: <string> - id: <string> name: <string> status: <string> category: <string> language: <string> createdAt: <string> modifiedAt: <string> errorReason: <string> count: <long> '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: <string> message: <string> /whatsappCampaigns/{campaignId}: put: tags: - Marketing > WhatsApp Campaigns summary: Update a WhatsApp campaign requestBody: content: '*/*': schema: type: string example: '""' parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json - name: campaignId in: path schema: type: string required: true description: id of the campaign to be updated responses: '200': description: Successful response content: application/json: {} /whatsappCampaigns/template: get: tags: - Marketing > WhatsApp Campaigns summary: Create a WhatsApp template parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /whatsappCampaigns/template/approval/{templateId}: post: tags: - Marketing > WhatsApp Campaigns summary: Send your WhatsApp template for approval requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: templateId in: path schema: type: string required: true description: Id of the WhatsApp template responses: '200': description: Successful response content: application/json: {} /whatsappCampaigns/config: get: tags: - Marketing > WhatsApp Campaigns summary: Get your WhatsApp API account information parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /contacts: get: tags: - Contact management > Contacts summary: Get all the contacts parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: modifiedSince in: query 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 date-time format for accurate result.** example: YYYY-MM-DDTHH:mm:ss.SSSZ - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: contacts: - email: contact1@example.com id: 247 emailBlacklisted: true smsBlacklisted: true createdAt: '2017-05-01T17:05:03.000Z' modifiedAt: '2017-05-01T17:05:03.000Z' listIds: - 43 - 58 attributes: SMS: '33058407250' IDENTIFICATION: 1-3RHQ-259 CIV: MS LAST_NAME: Brennon FIRST_NAME: Meg DOB: '1986-05-02T00:00:00.000Z' ADDRESS: 1 5th avenue ZIP_CODE: '44300' CITY: New-York ACTION_CODE: 17HH98CH - email: 33058407248@mailin-sms.com id: 245 emailBlacklisted: true smsBlacklisted: false createdAt: '2017-05-01T17:05:03.000Z' modifiedAt: '2017-05-01T17:05:03.000Z' listIds: - 43 - 61 - 58 attributes: SMS: '33058407248' IDENTIFICATION: 1-78JS-432 CIV: MS LAST_NAME: Press FIRST_NAME: Sophia DOB: '1980-09-11T00:00:00.000Z' ADDRESS: 5 Flower Street ZIP_CODE: '44119' CITY: Seattle ACTION_CODE: 17HU765 count: 3 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Contact management > Contacts summary: Create a contact requestBody: content: application/json: schema: type: object example: email: elly@example.com attributes: FNAME: Elly emailBlacklisted: false smsBlacklisted: false listIds: - 21 updateEnabled: false smtpBlacklistSender: - info@sendinblue.com security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 21 '204': description: No Content headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 21 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/doubleOptinConfirmation: post: tags: - Contact management > Contacts summary: Create Contact via DOI (Double-Opt-In) Flow requestBody: content: application/json: schema: type: object example: email: elly@example.com includeListIds: - 36 redirectionUrl: http://requestb.in/173lyyx1 templateId: 2 attributes: FNAME: John LNANE: Smith excludeListIds: - 6 security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/batch: post: tags: - Contact management > Contacts summary: Update multiple contacts requestBody: content: application/json: schema: type: object example: contacts: - email: john@example.com id: 31 attributes: FNAME: John LNAME: Smith emailBlacklisted: false smsBlacklisted: true listIds: - 65 unlinkListIds: - 36 smtpBlacklistSender: - KcV-PaFnJ@eS.qz - bbrb5LcqfbXwIx@rSlyeERMpQugHPvTXhPZo.zmg - email: Anna@example.com id: 31 attributes: FNAME: Anna Louise emailBlacklisted: false smsBlacklisted: true listIds: - 65 unlinkListIds: - 36 smtpBlacklistSender: - 0f8VdF@RMbQgSGQHKuglhsPAzZSJcrVpq.njc - UZzlbOKm7qXU@mvJPCUvDwPNk.lhjd parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '207': description: Multi-Status (WebDAV) (RFC 4918) headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: successIds: - -42087947 - 74324582 failureIds: - 670206 - -86165911 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/export: post: tags: - Contact management > Contacts summary: Export contacts description: >- It returns the background process ID which on completion calls the notify URL that you have set in the input. File will be available in csv. requestBody: content: application/json: schema: type: object example: customContactFilter: actionForContacts: subscribed actionForEmailCampaigns: hardBounces actionForSmsCampaigns: softBounces listId: 2 emailCampaignId: 12 smsCampaignId: 12 exportAttributes: - NAME - LNAME notifyUrl: http://requestb.in/173lyyx1 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: processId: 78 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/import: post: tags: - Contact management > Contacts summary: Import contacts description: >- It returns the background process ID which on completion calls the notify URL that you have set in the input. requestBody: content: application/json: schema: type: object example: fileUrl: https://importfile.domain.com fileBody: |- NAME;SURNAME;EMAIL Smith;John;john.smith@example.com Roger;Ellie;ellie36@example.com jsonBody: - ut_7f: Lorem deserunt_df: Lorem - exercitation_30: consequat Lorem listIds: - 76 - 76 notifyUrl: http://requestb.in/173lyyx1 newList: listName: ContactImport - 2017-05 folderId: 2 emailBlacklist: false smsBlacklist: false updateExistingContacts: true emptyContactsAttributes: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object examples: example-0: summary: process id created value: processId: 78 example-1: summary: import by fileUrl value: processId: 78 example-2: summary: import by fileBody value: processId: 78 example-3: summary: import by jsonBody value: processId: 78 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/{identifier}: get: tags: - Contact management > Contacts summary: Get a contact's details description: >- Along with the contact details, this endpoint will show the statistics of contact for the recent 90 days by default. To fetch the earlier statistics, please use Get contact campaign stats ``https://developers.sendinblue.com/reference/contacts-7#getcontactstats`` endpoint with the appropriate date ranges. parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 endDate example: YYYY-MM-DD - name: endDate in: query 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 startDate. example: YYYY-MM-DD - name: identifier in: path schema: type: string required: true description: >- (Required) Email (urlencoded) OR ID of the contact OR its SMS attribute value responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: email: peggy.rain@example.com id: 42 emailBlacklisted: false smsBlacklisted: false createdAt: '2017-05-02T16:40:31.000Z' modifiedAt: '2017-05-02T16:40:31.000Z' attributes: FIRST_NAME: Peggy LAST_NAME: Rain SMS: '3087433387669' CIV: '1' DOB: '1986-04-13T00:00:00.000Z' ADDRESS: 987 5th avenue ZIP_CODE: '87544' CITY: New-York AREA: NY listIds: - 40 statistics: messagesSent: - campaignId: 21 eventTime: '2016-05-03T20:15:13.000Z' - campaignId: 42 eventTime: '2016-10-17T10:30:01.000Z' opened: - campaignId: 21 count: 2 eventTime: '2016-05-03T21:24:56.000Z' ip: 66.249.93.118 - campaignId: 68 count: 1 eventTime: '2017-01-30T13:56:40.000Z' ip: 66.249.93.217 clicked: - campaignId: 21 links: - count: 2 eventTime: '2016-05-03T21:25:01.000Z' ip: 66.249.93.118 url: >- https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=sendinblue&utm_campaign=test_camp&utm_medium=email delivered: - campaignId: 21 count: 2 eventTime: '2016-05-03T21:24:56.000Z' ip: 66.249.93.118 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Contact management > Contacts summary: Delete a contact parameters: - name: Accept in: header schema: type: string example: application/json - name: identifier in: path schema: type: string required: true description: (Required) Email (urlencoded) OR ID of the contact responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '405': description: Method Not Allowed headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Contact management > Contacts summary: Update a contact requestBody: content: application/json: schema: type: object example: attributes: EMAIL: newemail@domain.com FNAME: Ellie LNAME: Roger emailBlacklisted: false smsBlacklisted: true listIds: - 65 unlinkListIds: - 36 smtpBlacklistSender: - 2tD@yHGSlOErIdPjXSRRCUPBPdlcwl.lkbz - IsBKLQFo@XuqjOjVDBfCmvxFMDtrmU.fogq parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: identifier in: path schema: type: string required: true description: (Required) Email (urlencoded) OR ID of the contact responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/{identifier}/campaignStats: get: tags: - Contact management > Contacts summary: Get email campaigns' statistics for a contact parameters: - name: Accept in: header schema: type: string example: application/json - name: startDate in: query 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 endDate example: YYYY-MM-DD - name: endDate in: query 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 startDate. Maximum difference between startDate and endDate should not be greater than 90 days example: YYYY-MM-DD - name: identifier in: path schema: type: string required: true description: (Required) Email (urlencoded) OR ID of the contact example: ' ' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: from: sendermail@example.com tags: - tag1 - tag2 messagesSent: - campaignId: 21 eventTime: '2016-05-03T20:15:13.000Z' - campaignId: 42 eventTime: '2016-10-17T10:30:01.000Z' - campaignId: 45 eventTime: '2016-11-09T11:45:02.000Z' opened: - campaignId: 21 count: 2 eventTime: '2016-05-03T21:24:56.000Z' ip: 66.249.93.118 - campaignId: 45 count: 1 eventTime: '2017-01-30T13:56:40.000Z' ip: 66.249.93.217 clicked: - campaignId: 21 links: - count: 2 eventTime: '2016-05-03T21:25:01.000Z' ip: 66.249.93.118 url: >- https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=sendinblue&utm_campaign=test_camp&utm_medium=email delivered: - campaignId: 21 count: 2 eventTime: '2016-05-03T21:24:56.000Z' ip: 66.249.93.118 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/folders: get: tags: - Contact management > Folders summary: Get all folders parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: (Required) Number of documents per page example: '10' - name: offset in: query schema: type: integer description: (Required) Index of the first document of the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: folders: - id: 42 name: Ninja_Form totalBlacklisted: 98 totalSubscribers: 4567 uniqueSubscribers: 4665 - id: 29 name: Prestashop totalBlacklisted: 10 totalSubscribers: 6543 uniqueSubscribers: 6553 count: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Contact management > Folders summary: Create a folder requestBody: content: application/json: schema: type: object example: name: Wordpress Contacts parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/folders/{folderId}: get: tags: - Contact management > Folders summary: Returns a folder's details parameters: - name: Accept in: header schema: type: string example: application/json - name: folderId in: path schema: type: integer required: true description: (Required) id of the folder example: '13396752' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 1 name: Client_Folder totalBlacklisted: 987 totalSubscribers: 16778 uniqueSubscribers: 17765 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Contact management > Folders summary: Update a folder requestBody: content: application/json: schema: type: object example: name: Wordpress Contacts parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: folderId in: path schema: type: integer required: true description: (Required) Id of the folder example: '13396752' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Contact management > Folders summary: Delete a folder (and all its lists) parameters: - name: Accept in: header schema: type: string example: application/json - name: folderId in: path schema: type: integer required: true description: (Required) Id of the folder example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/folders/{folderId}/lists: get: tags: - Contact management > Folders summary: Get lists in a folder parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '10' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc - name: folderId in: path schema: type: integer required: true description: (Required) Id of the folder example: '13396752' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: lists: - id: 46 name: Reactiv totalSubscribers: 7655 totalBlacklisted: 0 uniqueSubscribers: 7655 - id: 41 name: NY_Area totalSubscribers: 3654 totalBlacklisted: 23 uniqueSubscribers: 3677 - id: 22 name: VIP_Customer totalSubscribers: 8753 totalBlacklisted: 72 uniqueSubscribers: 8825 count: 3 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/lists: get: tags: - Contact management > Lists summary: Get all the lists parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '10' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: lists: - id: 53 name: Spanish_Speakers totalSubscribers: 5432 totalBlacklisted: 65 uniqueSubscribers: 5497 folderId: 1 - id: 50 name: Other totalSubscribers: 10976 totalBlacklisted: 765 uniqueSubscribers: 11741 folderId: 2 count: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Contact management > Lists summary: Create a list requestBody: content: application/json: schema: type: object example: folderId: 2 name: Magento Customer - ES parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/lists/{listId}/contacts: get: tags: - Contact management > Lists summary: Get contacts in a list parameters: - name: Accept in: header schema: type: string example: application/json - name: modifiedSince in: query 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 date-time format for accurate result.** - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: contacts: - email: alex.pain@example.com id: 45 emailBlacklisted: false smsBlacklisted: true createdAt: '2017-05-12T12:30:00.000Z' modifiedAt: '2017-05-12T12:30:00.000Z' listIds: - 12 - 9 - 20 listUnsubscribed: - 1 - 2 attributes: LASTNAME: Pain FIRSTNAME: Alex DOB: '2010-12-31T00:00:00.000Z' GENDER: Kid - email: john.smith@example.com id: 32 emailBlacklisted: true smsBlacklisted: false createdAt: '2017-05-12T12:30:00.000Z' modifiedAt: '2017-05-12T12:30:00.000Z' listIds: - 12 listUnsubscribed: - 1 attributes: LASTNAME: Smith FIRSTNAME: John DOB: '1986-06-21T00:00:00.000Z' GENDER: Men - email: helen.rose@example.com id: 65 emailBlacklisted: true smsBlacklisted: false createdAt: '2017-05-12T12:30:00.000Z' modifiedAt: '2017-05-12T12:30:00.000Z' listIds: - 12 - 9 - 20 listUnsubscribed: - 1 attributes: LASTNAME: Rose FIRSTNAME: Helen DOB: '1988-11-02T00:00:00.000Z' GENDER: Women SMS: '3375599887766' count: 17655 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/lists/{listId}/contacts/add: post: tags: - Contact management > Lists summary: Add existing contacts to a list requestBody: content: application/json: schema: type: object example: emails: - jeff32@example.com - jim56@example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '13396752' responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: success: - jeff32@example.com - jim56@example.com failure: - david@example.com '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/lists/{listId}/contacts/remove: post: tags: - Contact management > Lists summary: Delete a contact from a list requestBody: content: application/json: schema: type: object example: emails: - jeff32@example.com - jim56@example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '133' responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: success: - jeff32@example.com - jim56@example.com failure: - david@example.com '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/lists/{listId}: get: tags: - Contact management > Lists summary: Get a list's details parameters: - name: Accept in: header schema: type: string example: application/json - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 12 name: Newsletter_Weekly totalSubscribers: 6533 totalBlacklisted: 63 uniqueSubscribers: 6596 folderId: 1 createdAt: '2016-02-26T11:56:08.000Z' campaignStats: - campaignId: 15 stats: uniqueClicks: 701 clickers: 789 complaints: 0 delivered: 6632 sent: 6645 softBounces: 34 hardBounces: 4 uniqueViews: 3442 unsubscriptions: 4 viewed: 4322 deferred: 0 - campaignId: 45 stats: uniqueClicks: 654 clickers: 788 complaints: 1 delivered: 4078 sent: 4334 softBounces: 18 hardBounces: 2 uniqueViews: 987 unsubscriptions: 4 viewed: 1555 deferred: 0 dynamicList: false '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Contact management > Lists summary: Update a list requestBody: content: application/json: schema: type: object example: name: Magento Customer - ES folderId: 2 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Contact management > Lists summary: Delete a list parameters: - name: Accept in: header schema: type: string example: application/json - name: listId in: path schema: type: integer required: true description: (Required) Id of the list example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /contacts/attributes: get: tags: - Contact management > Attributes summary: List all attributes parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: attributes: - name: LASTNAME category: normal type: text - name: FIRSTNAME category: normal type: text - name: DOB category: normal type: date - name: GENDER category: category type: text enumeration: - value: 1 label: Men - value: 2 label: Women - value: 3 label: Kid /contacts/attributes/{attributeCategory}/{attributeName}: put: tags: - Contact management > Attributes summary: Update contact attribute requestBody: content: application/json: schema: type: object example: value: COUNT[BLACKLISTED,BLACKLISTED,<,NOW()] enumeration: - label: Men value: 1 - label: Men value: 1 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: attributeCategory in: path schema: type: string required: true description: (Required) Category of the attribute example: global - name: attributeName in: path schema: type: string required: true description: (Required) Name of the existing attribute example: Name responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Contact management > Attributes summary: Create contact attribute requestBody: content: application/json: schema: type: object example: value: COUNT[BLACKLISTED,BLACKLISTED,<,NOW()] enumeration: - label: Women value: 1 - label: Women value: 1 type: text parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: attributeCategory in: path schema: type: string required: true description: (Required) Category of the attribute example: global - name: attributeName in: path schema: type: string required: true description: (Required) Name of the attribute example: Country responses: '201': description: Created headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Contact management > Attributes summary: Delete an attribute parameters: - name: Accept in: header schema: type: string example: application/json - name: attributeCategory in: path schema: type: string required: true description: (Required) Category of the attribute example: global - name: attributeName in: path schema: type: string required: true description: (Required) Name of the existing attribute example: Country responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /webhooks: get: tags: - Accounts and settings > Webhooks summary: Get all webhooks parameters: - name: Accept in: header schema: type: string example: application/json - name: type in: query schema: type: string description: Filter on webhook type example: transactional - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of webhook creation example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: webhooks: - url: https://example.domain.com/webhook/events/kzfxxxxxxxx0uyo1 id: 9864 description: Webhook triggered on campaign openings events: - opened type: transac createdAt: '2016-07-18T12:30:09.000Z' modifiedAt: '2016-07-18T16:00:50.000Z' - url: http://exmaple.domain.com/15kxxxxxn1 id: 22770 description: Webhook triggered on campaign hard bounces events: - hardBounces type: marketing createdAt: '2017-02-20T14:30:00.000Z' modifiedAt: '2017-02-20T19:00:00.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Accounts and settings > Webhooks summary: Create a webhook requestBody: content: application/json: schema: type: object example: events: - delivered url: https://webhook.site/5ebc5d36-217f-4989-81fd-5f02cbb49c6d description: test for SMS type: marketing security: - apikeyAuth: [] parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /webhooks/{webhookId}: get: tags: - Accounts and settings > Webhooks summary: Get a webhook details parameters: - name: Accept in: header schema: type: string example: application/json - name: webhookId in: path schema: type: integer required: true description: (Required) Id of the webhook example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: url: http://example.domain.com/1brxxxxxx5p1 id: 7287 description: Webhook triggered on campaign openings and addition of lists events: - listAdditions - opened type: marketing createdAt: '2016-06-07T09:10:10.000Z' modifiedAt: '2016-06-08T11:30:00.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Accounts and settings > Webhooks summary: Update a webhook requestBody: content: application/json: schema: type: object example: url: http://requestb.in/173lyyx1 description: Webhook triggered on contact hardbounce events: - hardBounce - hardBounce domain: example.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: webhookId in: path schema: type: integer required: true description: (Required) Id of the webhook example: '1333' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Accounts and settings > Webhooks summary: Delete a webhook parameters: - name: Accept in: header schema: type: string example: application/json - name: webhookId in: path schema: type: integer required: true description: (Required) Id of the webhook example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/credits/add: post: tags: - Accounts and settings > Reseller > Credits summary: Add Email and/or SMS credits to a specific child account requestBody: content: application/json: schema: type: object example: sms: 450 email: 1200 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: child: sms: 500 email: 2000 reseller: sms: 12900 email: 2000000 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/credits/remove: post: tags: - Accounts and settings > Reseller > Credits summary: Remove Email and/or SMS credits from a specific child account requestBody: content: application/json: schema: type: object example: sms: 300 email: 500 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: child: sms: 500 email: 2000 reseller: sms: 12900 email: 2000000 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/ips/associate: post: tags: - Accounts and settings > Reseller > IP management summary: Associate a dedicated IP to the child requestBody: content: application/json: schema: type: object example: ip: 123.65.8.22 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/ips/dissociate: post: tags: - Accounts and settings > Reseller > IP management summary: Dissociate a dedicated IP to the child requestBody: content: application/json: schema: type: object example: ip: 123.65.8.22 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/domains: get: tags: - Accounts and settings > Reseller > Domains summary: Get all sender domains for a specific child account parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - domain: mycustomdomain.com active: true - domain: mynewdomain.com active: true '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Accounts and settings > Reseller > Domains summary: Create a domain for a child account requestBody: content: application/json: schema: type: object example: domain: mychilddomain.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '201': description: Created headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/domains/{domainName}: put: tags: - Accounts and settings > Reseller > Domains summary: >- Update the sender domain of reseller's child based on the childIdentifier and domainName passed requestBody: content: application/json: schema: type: object example: domain: myupdateddomain.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child - name: domainName in: path schema: type: string required: true description: (Required) Pass the existing domain that needs to be updated responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Accounts and settings > Reseller > Domains summary: >- Delete the sender domain of the reseller child based on the childIdentifier and domainName passed parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child - name: domainName in: path schema: type: string required: true description: (Required) Pass the existing domain that needs to be deleted responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}: get: tags: - Accounts and settings > Reseller > Child accounts summary: Get a child account's details parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: email: john.smith@example.com firstName: John lastName: Smith companyName: MyCompany credits: emailCredits: 98555 smsCredits: 87556 statistics: previousMonthTotalSent: 7654 currentMonthTotalSent: 4566 totalSent: 987554 password: abC0xxxxx3jkL ips: - 176.2.39.4 - 231.43.21.7 apiKeys: v2: - name: N˚2 key: nOpxxxxxy7z v3: - name: N˚3 key: xkeysib-21881axxxxxcc92e04-mIrexxxx7z '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Accounts and settings > Reseller > Child accounts summary: Update info of reseller's child based on the child identifier supplied requestBody: content: application/json: schema: type: object example: email: josh.cruise@example.com firstName: Josh lastName: Cruise companyName: Your Company password: Pa55w0rd65 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Accounts and settings > Reseller > Child accounts summary: Delete a single reseller child based on the child identifier supplied parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or child id of reseller's child responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/accountStatus: put: tags: - Accounts and settings > Reseller > Child accounts summary: >- Update info of reseller's child account status based on the identifier supplied requestBody: content: application/json: schema: type: object example: transactionalEmail: false transactionalSms: false marketingAutomation: true smsCampaign: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/accountCreationStatus: get: tags: - Accounts and settings > Reseller > Child accounts summary: >- Get the status of a reseller's child account creation, whether it is successfully created (exists) or not based on the childIdentifier supplied parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: childAccountCreated: true '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children/{childIdentifier}/auth: get: tags: - Accounts and settings > Reseller > Child accounts summary: Get session token to access Sendinblue (SSO) description: >- It returns a session [token] which will remain valid for a short period of time. A child account will be able to access a white-labeled section by using the following url pattern => https:/email.mydomain.com/login/sso?token=[token] parameters: - name: Accept in: header schema: type: string example: application/json - name: childIdentifier in: path schema: type: string required: true description: (Required) Either auth key or id of reseller's child responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: token: 5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /reseller/children: get: tags: - Accounts and settings > Reseller > Child accounts summary: Get the list of all children accounts parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents for child accounts information per page example: '10' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: children: - email: john.smith@example.com firstName: John lastName: Smith companyName: MyCompany credits: emailCredits: 98555 smsCredits: 87556 statistics: previousMonthTotalSent: 7654 currentMonthTotalSent: 4566 totalSent: 987554 password: abC0xxxxxx3jkL ips: - 176.2.39.4 - 231.43.21.7 apiKeys: v2: - name: N˚2 key: nOpxxxxxy7z v3: - name: N˚3 key: xkeysib-21881axxxxxcc92e04-mIrexxxx7z id: 187588 - email: alex.pain@example.com firstName: Alex lastName: Pain companyName: MyStore credits: emailCredits: 2000 smsCredits: 0 statistics: previousMonthTotalSent: 654 currentMonthTotalSent: 300 totalSent: 6553 password: abC0xxxxx64kL ips: - 176.2.39.4 - 231.43.21.7 apiKeys: v2: - name: N˚2 key: nOpxxxxxy7z v3: - name: N˚3 key: xkeysib-21881axxxxxcc92e04-mIrexxxx7z id: 187669 '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Accounts and settings > Reseller > Child accounts summary: Creates a reseller child requestBody: content: application/json: schema: type: object example: companyName: Your Company email: josh.cruise@example.com firstName: Josh lastName: Cruise password: Pa55w0rd65 language: en parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: authKey: xkeysib-21881axxxxxcc92e04-mIrexxxx7z id: 1234567 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /processes: get: tags: - Accounts and settings > Process summary: Return all the processes for your account parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number limitation for the result returned example: '10' - name: offset in: query schema: type: integer description: Beginning point in the list to retrieve from. example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: processes: - id: 40 status: completed name: TRANS-CALC - id: 43 status: queued name: TRANS-GLOBAL-CALC - id: 194 status: completed name: SEARCH_EXPORT_USERS export_url: >- <a href="https://export-url.com/upload/file-name.csv" target="_blank">filename.csv</a> count: 3 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /processes/{processId}: get: tags: - Accounts and settings > Process summary: Return the informations for a process parameters: - name: Accept in: header schema: type: string example: application/json - name: processId in: path schema: type: integer required: true description: (Required) Id of the process example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 194 status: completed name: SEARCH_EXPORT_USERS export_url: >- <a href="https://export-url.com/upload/file-name.csv" target="_blank">filename.csv</a> '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: processId is invalid /corporate/masterAccount: get: tags: - Accounts and settings > Corporate summary: Get the details of requested master account description: This endpoint will provide the details of the master account. parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: email: sample@example.com companyName: Corp Sample 1-1 id: 1003286 currencyCode: INR timezone: Europe/Paris billingInfo: email: sample@example.com companyName: Corp Sample 1-1 name: givenName: Uday familyName: Pandit address: streetAddress: C-92 locality: Pandav Nagar, New Delhi postalCode: '560048' stateCode: UP countryCode: IN planInfo: currencyCode: INR nextBillingAt: 1637739295 price: 2100 planPeriod: month subAccounts: 15 features: - name: MULTI_USER unitValue: 1 quantity: 10 used: 15 remaining: 0 - name: ADVANCED_REPORTING unitValue: 1 quantity: 12 used: 1 remaining: 11 - name: INBOX unitValue: 1 quantity: 10 used: 10 remaining: 0 - name: LANDING_PAGE unitValue: 5 quantity: 10 used: 11 remaining: 0 - name: RECURRING_CREDITS unitValue: 1 quantity: 500 used: 1 remaining: 499 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /corporate/subAccount: get: tags: - Accounts and settings > Corporate summary: Get the list of all the sub-accounts of the master account. description: >- This endpoint will provide the list all the sub-accounts of the master account. parameters: - name: Accept in: header schema: type: string example: application/json - name: offset in: query schema: type: string description: (Required) Index of the first sub-account in the page - name: limit in: query schema: type: string description: (Required) Number of sub-accounts to be displayed on each page responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: count: 3 subAccounts: - id: 4043629 companyName: Company1 active: true, createdAt: 1631523176 - id: 3984002 companyName: Company2 active: true createdAt: 1629439311 - id: 3524191 companyName: Company3 active: true createdAt: 1614713641 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Accounts and settings > Corporate summary: Create a new sub-account under a master account. description: This endpoint will create a new sub-account under a master account requestBody: content: application/json: schema: type: object example: companyName: Test Sub-account email: test-sub@example.com timezone: Europe/Paris language: en parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 4109344 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: missing_parameter message: Missing companyName attribute in the request /corporate/subAccount/ssoToken: post: tags: - Accounts and settings > Corporate summary: Generate SSO token to access Sendinblue description: >- This endpoint generates an sso token to authenticate and access a sub-account of the master using the account endpoint https://app.sendinblue.com/account/login/sub-account/sso/[token], where [token] will be replaced by the actual token. requestBody: content: application/json: schema: type: object example: id: 3232323 email: vipin+subaccount@sendinblue.com parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: token: 5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: invalid_parameter message: Invalid sub-account id. '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: permission_denied message: Access forbidden. /corporate/subAccount/{id}: get: tags: - Accounts and settings > Corporate summary: Get sub-account details description: >- This endpoint will provide the details for the specified sub-account company parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: integer required: true description: (Required) Id of the sub-account organization example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: name: Uday Pandit email: uday+1@sendinblue.com companyName: API-Sub-26thOct21-4 planInfo: credits: sms: 1234 emails: quantity: 2000 remaining: 1955 features: inbox: quantity: 20 remaining: 12 landingPage: quantity: 25 remaining: 14 users: quantity: 30 remaining: 14 planType: paid '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Accounts and settings > Corporate summary: Delete a sub-account parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: integer required: true description: (Required) Id of the sub-account organization to be deleted example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: missing_parameter message: Sub-account 2039dfsddf885 is not valid '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: document_not_found message: Sub-account 2039885 was not found /corporate/subAccount/{id}/plan: put: tags: - Accounts and settings > Corporate summary: Update sub-account plan description: This endpoint will update the sub-account plan requestBody: content: application/json: schema: type: object example: credits: email: 5000 features: users: 15 landingPage: 20 inbox: 10 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: integer required: true description: (Required) Id of the sub-account organization example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '403': description: Forbidden headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: permission_denied message: Access forbidden. /account: get: tags: - Accounts and settings > Account data summary: Get your account information, plan and credits details parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: plan: - type: payAsYouGo credits: 5000 creditsType: sendLimit - type: subscription credits: 39983 creditsType: sendLimit startDate: '2017-03-11T00:00:00.000Z' endDate: '2017-04-11T00:00:00.000Z' - type: sms credits: 999.5360000000001 creditsType: sendLimit relay: enabled: true data: userName: john.smith@example.com relay: smtp-relay.domain.com port: 587 marketingAutomation: key: kzfr5xxxxxxttuyo1 enabled: true email: john.smith@example.com firstName: John lastName: Smith companyName: MyShop address: city: New-York street: 1677B 8th Avenue zipCode: '7665' country: USA /senders: get: tags: - Accounts and settings > Senders summary: Get the list of all your senders parameters: - name: Accept in: header schema: type: string example: application/json - name: ip in: query schema: type: string description: > Filter your senders for a specific ip. **Available for dedicated IP usage only** - name: domain in: query schema: type: string description: Filter your senders for a specific domain responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: senders: - id: 1 name: Marketing email: marketing@mycompany.com active: true ips: - ip: 123.98.689.7 domain: mycompany.com weight: 100 - id: 2 name: Newsletter email: newsletter@mycompany.com active: false ips: - ip: 123.98.689.7 domain: mycompany.com weight: 50 - ip: 123.98.643.2 domain: news.mycompany.com weight: 50 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - Accounts and settings > Senders summary: Create a new sender requestBody: content: application/json: schema: type: object example: email: newsletter@mycompany.com name: Newsletter ips: - domain: mycompany.com ip: 123.98.689.7 weight: 50 - domain: mycompany.com ip: 123.98.689.7 weight: 50 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 5 spfError: true dkimError: false '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /senders/ips: get: tags: - Accounts and settings > Senders summary: Get all the dedicated IPs for your account parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: ips: - id: 3 ip: 67.145.89.3 active: true domain: mailing.myshop.com - id: 5 ip: 76.76.125.9 active: true domain: newsletter.myshop.com - id: 6 ip: 123.65.8.22 active: false domain: notifications.myshop.com /senders/{senderId}: put: tags: - Accounts and settings > Senders summary: Update a sender requestBody: content: application/json: schema: type: object example: name: Newsletter email: newsletter@mycompany.com ips: - domain: mycompany.com ip: 123.98.689.7 weight: 50 - domain: mycompany.com ip: 123.98.689.7 weight: 50 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: senderId in: path schema: type: integer required: true description: (Required) Id of the sender example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Accounts and settings > Senders summary: Delete a sender parameters: - name: Accept in: header schema: type: string example: application/json - name: senderId in: path schema: type: integer required: true description: (Required) Id of the sender example: '133' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /senders/{senderId}/ips: get: tags: - Accounts and settings > Senders summary: Get all the dedicated IPs for a sender parameters: - name: Accept in: header schema: type: string example: application/json - name: senderId in: path schema: type: integer required: true description: (Required) Id of the sender example: '133' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: ips: - id: 3 ip: 123.65.8.22 domain: mailing.myshop.dom weight: 40 - id: 5 ip: 123.43.21.3 domain: newsletter.myshop.dom weight: 60 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /senders/domains: get: tags: - Accounts and settings > Domains summary: Get the list of all your domains parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Date: schema: type: string example: Wed, 12 Apr 2023 13:23:33 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive CF-Ray: schema: type: string example: 7b6bc8d48b4d3fc8-SIN Access-Control-Allow-Origin: schema: type: string example: https://ip-management-api.sendinblue.com,* Cache-Control: schema: type: string example: no-cache, private CF-Cache-Status: schema: type: string example: DYNAMIC access-control-allow-credentials: schema: type: string example: true,true access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS cf-apo-via: schema: type: string example: origin,host sib-request-id: schema: type: string example: 9efd2f9e-02d1-9058-b5a1-477084fe7cbb x-content-type-options: schema: type: string example: nosniff x-envoy-upstream-service-time: schema: type: integer example: '85' x-sib-server: schema: type: string example: srv-pr-rancher-worker-9.prod.illiad.51b.tech x-xss-protection: schema: type: integer example: '1' Set-Cookie: schema: type: string example: >- __cf_bm=jjdjt_Olg06YrVhRTYPT40dkbJZZEsH.DSlDr0NIsMI-1681305813-0-ATGEO0wCmmTqDZ47Oe2rSfjwevZL1p4EHWii6y7A9dNJmjPyUiYaFYTLyNWWgqJSxg9MAs2KrE7YPqKmshtNPJE=; path=/; expires=Wed, 12-Apr-23 13:53:33 GMT; domain=.sendinblue.com; HttpOnly; Secure; SameSite=None Vary: schema: type: string example: Accept-Encoding Server: schema: type: string example: cloudflare Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: domains: - id: 6422f42c57ffaf38d12b22eb domain_name: mycompany.com authenticated: false verified: false validationRequest: null verifier: null authenticator: null creator: id: 63930fe975f3bf52825956b7 email: obaidullah.khan@sendinblue.com method: null creationDate: '2023-03-28T14:05:32+00:00' ip: null - id: 64269a2ef4eb29425632cca9 domain_name: mynewcompany.com authenticated: false verified: false validationRequest: null verifier: null authenticator: null creator: id: 63930fe975f3bf52825956b7 email: obaidullah.khan@sendinblue.com method: null creationDate: '2023-03-31T08:30:38+00:00' ip: null - id: 64269ec8bc5e5f637b17fab8 domain_name: gmail.com authenticated: false verified: false validationRequest: null verifier: null authenticator: null creator: id: 63930fe975f3bf52825956b7 email: obaidullah.khan@sendinblue.com method: null creationDate: '2023-03-31T08:50:16+00:00' ip: null - id: 6436abc9462d851d8608df99 domain_name: myfirstcompany.com authenticated: false verified: false validationRequest: null verifier: null authenticator: null creator: id: 63930fe975f3bf52825956b7 email: obaidullah.khan@sendinblue.com method: null creationDate: '2023-04-12T13:02:01+00:00' ip: null count: 4 current_page: 1 total_pages: 1 post: tags: - Accounts and settings > Domains summary: Create a new domain requestBody: content: '*/*': schema: type: string example: '"{\n \"name\": \"myfirstcompany.com\"\n}"' parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: name in: query schema: type: string description: Domain name responses: '200': description: OK headers: Date: schema: type: string example: Wed, 12 Apr 2023 12:54:44 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive cache-control: schema: type: string example: no-cache, private access-control-allow-origin: schema: type: string example: https://ip-management-api.sendinblue.com,* access-control-allow-credentials: schema: type: string example: true,true access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* x-envoy-upstream-service-time: schema: type: integer example: '315' sib-request-id: schema: type: string example: ac62faa3-73bd-9174-8e0a-f30d24b384cf x-sib-server: schema: type: string example: srv-pr-rancher-worker-12.prod.illiad.51b.tech x-content-type-options: schema: type: string example: nosniff x-xss-protection: schema: type: integer example: '1' CF-Cache-Status: schema: type: string example: DYNAMIC Server: schema: type: string example: cloudflare CF-RAY: schema: type: string example: 7b6b9e9bcaeea039-SIN Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: id: 6436aa14a06d401e7559fb6b domain_name: myfirstcompany.com message: >- Domain added successfully. To authenticate it, add following DNS records dns_records: dkim_record: type: TXT value: >- k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDeMVIzrCa3T14JsNY0IRv5/2V1/v2itlviLQBwXsa7shBD6TrBkswsFUToPyMRWC9tbR/5ey0nRBH0ZVxp+lsmTxid2Y2z+FApQ6ra2VsXfbJP3HE6wAO0YTVEJt1TmeczhEd2Jiz/fcabIISgXEdSpTYJhb0ct0VJRxcg4c8c7wIDAQAB host_name: mail._domainkey. status: false sendinblue_code: type: TXT value: sendinblue-code:e760f020e6d438149540cfc757e99b5a host_name: '' status: false /senders/domains/{domainName}: delete: tags: - Accounts and settings > Domains summary: Delete a domain parameters: - name: Accept in: header schema: type: string example: application/json - name: domainName in: path schema: type: string required: true example: myfirstcompany.com responses: '200': description: OK headers: Date: schema: type: string example: Wed, 12 Apr 2023 12:55:12 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive cache-control: schema: type: string example: no-cache, private access-control-allow-origin: schema: type: string example: https://ip-management-api.sendinblue.com,* access-control-allow-credentials: schema: type: string example: true,true access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* x-envoy-upstream-service-time: schema: type: integer example: '64' sib-request-id: schema: type: string example: 5946bf09-800a-963f-9a06-56a7dbe92c98 x-sib-server: schema: type: string example: srv-pr-rancher-worker-8.prod.illiad.51b.tech x-content-type-options: schema: type: string example: nosniff x-xss-protection: schema: type: integer example: '1' CF-Cache-Status: schema: type: string example: DYNAMIC Server: schema: type: string example: cloudflare CF-RAY: schema: type: string example: 7b6b9f4f1a50a039-SIN Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: null /v3/senders/domains/{domainName}: get: tags: - Accounts and settings > Domains summary: Validate domain configuration parameters: - name: Accept in: header schema: type: string example: application/json - name: domainName in: path schema: type: string required: true example: mynewcompany.com responses: '200': description: OK headers: Date: schema: type: string example: Wed, 12 Apr 2023 12:56:23 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive CF-Ray: schema: type: string example: 7b6ba1073d73a039-SIN Access-Control-Allow-Origin: schema: type: string example: https://ip-management-api.sendinblue.com,* Cache-Control: schema: type: string example: no-cache, private CF-Cache-Status: schema: type: string example: DYNAMIC access-control-allow-credentials: schema: type: string example: true,true access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS cf-apo-via: schema: type: string example: origin,host sib-request-id: schema: type: string example: b4989511-6a6a-9793-a2e3-bea45ac6cbaa x-content-type-options: schema: type: string example: nosniff x-envoy-upstream-service-time: schema: type: integer example: '142' x-sib-server: schema: type: string example: srv-pr-rancher-worker-12.prod.illiad.51b.tech x-xss-protection: schema: type: integer example: '1' Set-Cookie: schema: type: string example: >- __cf_bm=K490lzWIrbF6NBRY1R.Bpfy6WKzYMM6x2BallbgxZ0k-1681304183-0-AdL701hhWsoI1FJWLEXnVTW8kOke/+pnR0vjaJK7x6qtLHxxNnhUp86fg2Z8KpwNNZvzupdfYhXq3xCNhEJtMgM=; path=/; expires=Wed, 12-Apr-23 13:26:23 GMT; domain=.sendinblue.com; HttpOnly; Secure; SameSite=None Vary: schema: type: string example: Accept-Encoding Server: schema: type: string example: cloudflare Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: domain: mynewcompany.com verified: false authenticated: false dns_records: dkim_record: type: TXT value: >- k=rsa;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDeMVIzrCa3T14JsNY0IRv5/2V1/v2itlviLQBwXsa7shBD6TrBkswsFUToPyMRWC9tbR/5ey0nRBH0ZVxp+lsmTxid2Y2z+FApQ6ra2VsXfbJP3HE6wAO0YTVEJt1TmeczhEd2Jiz/fcabIISgXEdSpTYJhb0ct0VJRxcg4c8c7wIDAQAB host_name: mail._domainkey. status: false sendinblue_code: type: TXT value: sendinblue-code:e760f020e6d438149540cfc757e99b5a host_name: '' status: false /senders/domains/{domainName}/authenticate: put: tags: - Accounts and settings > Domains summary: Authenticate a domain requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: domainName in: path schema: type: string required: true description: Domain to be authenticated example: mynewcompany.com responses: '400': description: Bad Request headers: Date: schema: type: string example: Wed, 12 Apr 2023 12:53:08 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive cache-control: schema: type: string example: no-cache, private access-control-allow-origin: schema: type: string example: https://ip-management-api.sendinblue.com,* access-control-allow-credentials: schema: type: string example: true,true access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* x-envoy-upstream-service-time: schema: type: integer example: '219' sib-request-id: schema: type: string example: b3d6c5df-ba91-9091-b4d8-42ed05dd2f04 x-sib-server: schema: type: string example: srv-pr-rancher-worker-12.prod.illiad.51b.tech x-content-type-options: schema: type: string example: nosniff x-xss-protection: schema: type: integer example: '1' CF-Cache-Status: schema: type: string example: DYNAMIC Server: schema: type: string example: cloudflare CF-RAY: schema: type: string example: 7b6b9c440eb5a039-SIN content: application/json: schema: type: object example: code: bad_request message: >- The domain cannot be authenticated. Check your domain DNS panel and ensure both the Sendinblue code and DKIM record are added correctly. /organization/invited/users: get: tags: - Accounts and settings > User summary: Get the list of all your users parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Date: schema: type: string example: Tue, 07 Nov 2023 13:00:48 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive CF-Ray: schema: type: string example: 8225c2e43d0f35fa-FRA CF-Cache-Status: schema: type: string example: DYNAMIC Access-Control-Allow-Origin: schema: type: string example: https://account-management-backend.sendinblue.com,* Cache-Control: schema: type: string example: no-cache, private access-control-allow-credentials: schema: type: string example: true,true access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS cf-apo-via: schema: type: string example: origin,host sib-request-id: schema: type: string example: dfa4b3ff-48b0-9539-b8f2-7d9b2faa5b66 traceresponse: schema: type: string example: 00-9a3c781b3e8d2df7bc03a66eb1810c48-c4d198ce98c7a369-01 x-content-type-options: schema: type: string example: nosniff x-dt-tracestate: schema: type: string example: 14ea3eee-a07e0240@dt x-envoy-upstream-service-time: schema: type: integer example: '91' x-sib-server: schema: type: string example: srv-pr-online-rancher-worker-60.onl.51b.tech x-xss-protection: schema: type: integer example: '1' Set-Cookie: schema: type: string example: >- __cf_bm=EU_VIQcVi803sxGSV5O45Wbyugj1UUnqIz_Tgwgvp2c-1699362048-0-AeI5cChIaOGpMnXfeVLxqnpQ7YV+SoYpMAiebYwd81V8cJO1P/nyUNExQerhNpia9JPtDrK/JBsgs/IiCB9qsvM=; path=/; expires=Tue, 07-Nov-23 13:30:48 GMT; domain=.sendinblue.com; HttpOnly; Secure; SameSite=None Vary: schema: type: string example: Accept-Encoding Server: schema: type: string example: cloudflare Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: users: - email: obaidullah.khan@brevo.com is_owner: true status: active feature_access: marketing: owner conversations: owner crm: owner phone: none /organization/user/{email}/permissions: get: tags: - Accounts and settings > User summary: Check user permission parameters: - name: email in: path schema: type: string required: true description: Email of the invited user responses: '200': description: Successful response content: application/json: {} /organization/user/invitation/revoke/{email}: put: tags: - Accounts and settings > User summary: Revoke user permission requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: email in: path schema: type: string required: true description: Email of the invited user responses: '200': description: Successful response content: application/json: {} /organization/user/invitation/{action}/{email}: put: tags: - Accounts and settings > User summary: Resend / Cancel invitation requestBody: content: {} parameters: - name: action in: path schema: type: string required: true description: Resending or cancelling an invitation - name: email in: path schema: type: string required: true description: Email of the invited user responses: '200': description: Successful response content: application/json: {} /organization/user/invitation/send: post: tags: - Accounts and settings > User summary: Send invitation to user requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: OK headers: Date: schema: type: string example: Tue, 07 Nov 2023 13:06:29 GMT Content-Type: schema: type: string example: application/json Transfer-Encoding: schema: type: string example: chunked Connection: schema: type: string example: keep-alive x-dt-tracestate: schema: type: string example: 14ea3eee-a07e0240@dt traceresponse: schema: type: string example: 00-474aa548570b84d07c19b7d65b450d97-f309a46196b98195-01 cache-control: schema: type: string example: no-cache, private access-control-allow-origin: schema: type: string example: https://account-management-backend.sendinblue.com,* access-control-allow-credentials: schema: type: string example: true,true access-control-allow-methods: schema: type: string example: >- GET, POST, OPTIONS, PUT, PATCH, HEAD,PUT, POST, GET, DELETE, PATCH, OPTIONS access-control-allow-headers: schema: type: string example: >- Authorization, Origin, X-Requested-With, Content-Type, Accept, x-xsrf-token, x-csrf-token,* x-envoy-upstream-service-time: schema: type: integer example: '1619' sib-request-id: schema: type: string example: 26b895ee-76d9-9264-9ab1-d2d251f5773c x-sib-server: schema: type: string example: srv-pr-rancher-worker-15.prod.illiad.51b.tech x-content-type-options: schema: type: string example: nosniff x-xss-protection: schema: type: integer example: '1' CF-Cache-Status: schema: type: string example: DYNAMIC Server: schema: type: string example: cloudflare CF-RAY: schema: type: string example: 8225cb2cff8035fa-FRA Content-Encoding: schema: type: string example: br content: application/json: schema: type: object example: status: OK /organization/user/update/permissions: post: tags: - Accounts and settings > User summary: Update permission for a user requestBody: content: {} parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json - name: all_features_access in: query schema: type: boolean example: 'true' responses: '200': description: Successful response content: application/json: {} /companies: get: tags: - Sales CRM > Companies summary: Get all Companies security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: filters in: query 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 schema: type: string description: Filter by linked contacts ids - name: linkedDealsIds in: query schema: type: string description: Filter by linked Deals ids - name: page in: query schema: type: integer description: Index of the first document of the page example: '0' - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed example: desc - name: sortBy in: query schema: type: string description: The field used to sort field names. responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: items: - id: 629475917295261d9b1f4403 attributes: created_at: '2022-01-13T19:04:24.376+05:30' domain: xyz last_updated_at: '2022-04-01T18:47:48.283+05:30' name: text number_of_contacts: 0 owner: 62260474111b1101704a9d85 owner_assign_date: '2022-04-01T18:21:13.379+05:30' phone_number: 8171844192 revenue: 10 linkedContactsIds: - 1 - 2 - 3 linkedDealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 - id: 629475917295261d9b1f4403 attributes: created_at: '2022-01-13T19:04:24.376+05:30' domain: xyz last_updated_at: '2022-04-01T18:47:48.283+05:30' name: text number_of_contacts: 0 owner: 62260474111b1101704a9d85 owner_assign_date: '2022-04-01T18:21:13.379+05:30' phone_number: 8171844192 revenue: 10 linkedContactsIds: - 1 - 2 - 3 linkedDealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. post: tags: - Sales CRM > Companies summary: Create a company requestBody: content: application/json: schema: type: object example: name: company attributes: domain: https://example.com industry: Fabric owner: 60e68d60582a3b006f524197 countryCode: 91 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 61a5cd07ca1347c82306ad06 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. /companies/attributes: get: tags: - Sales CRM > Companies summary: Get company attributes parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - internalName: name label: Company Name attributeTypeName: text attributeOptions: - key: custom key value: custom label - key: custom key value: custom label isRequired: true - internalName: name label: Company Name attributeTypeName: text attributeOptions: - key: custom key value: custom label - key: custom key value: custom label isRequired: true /companies/link-unlink/{id}: patch: tags: - Sales CRM > Companies summary: Link and Unlink company with contact and deal requestBody: content: application/json: schema: type: object example: linkContactIds: - 1 - 2 - 3 unlinkContactIds: - 4 - 5 - 6 linkDealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 unlinkDealsIds: - 61a5ce58c5d4795761045994 - 61a5ce58c5d479576104595 - 61a5ce58c5d4795761045996 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. /companies/{id}: get: tags: - Sales CRM > Companies summary: Get a company parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Get Company Details responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 629475917295261d9b1f4403 attributes: created_at: '2022-01-13T19:04:24.376+05:30' domain: xyz last_updated_at: '2022-04-01T18:47:48.283+05:30' name: text number_of_contacts: 0 owner: 62260474111b1101704a9d85 owner_assign_date: '2022-04-01T18:21:13.379+05:30' phone_number: 8171844192 revenue: 10 linkedContactsIds: - 1 - 2 - 3 linkedDealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route company id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found delete: tags: - Sales CRM > Companies summary: Delete a company parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Company ID to delete responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route company id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found patch: tags: - Sales CRM > Companies summary: Update a company requestBody: content: application/json: schema: type: object example: name: company attributes: category: label_2 domain: xyz date: '2022-05-04T00:00:00+05:30' industry: flipkart number_of_contacts: 1 number_of_employees: 100 owner: 5b1a17d914b73d35a76ca0c7 phone_number: '81718441912' revenue: 10000.34222 countryCode: 91 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 629475917295261d9b1f4403 attributes: created_at: '2022-01-13T19:04:24.376+05:30' domain: xyz last_updated_at: '2022-04-01T18:47:48.283+05:30' name: text number_of_contacts: 0 owner: 62260474111b1101704a9d85 owner_assign_date: '2022-04-01T18:21:13.379+05:30' phone_number: 8171844192 revenue: 10 linkedContactsIds: - 1 - 2 - 3 linkedDealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /crm/pipeline/details: get: tags: - Sales CRM > Companies summary: Get pipeline stages parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: stages: - id: 9e577ff7-8e42-4ab3-be26-2b5e01b42518 name: New - id: 9e577ff7-8e42-4ab3-be26-2b5e01b42518 name: New /crm/deals: get: tags: - Sales CRM > Deals summary: Get all deals parameters: - name: Accept in: header schema: type: string example: application/json - name: filter[attributes] in: query schema: type: string description: >- Filter by attrbutes. If you have filter for owner on your side please send it as `attributes.owner`." - name: filter[linkedCompaniesIds] in: query schema: type: string description: Filter by linked companies ids - name: filter[linkedContactsIds] in: query schema: type: string description: Filter by linked companies ids - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: items: - id: 629475917295261d9b1f4403 attributes: deal_name: testname deal_owner: 6093d2425a9b436e9519d034 amount: 12 pipeline: 6093d296ad1e9c5cf2140a58 deal_stage: 9e577ff7-8e42-4ab3-be26-2b5e01b42518 stage_updated_at: '2022-05-30T07:42:05.671Z' created_at: '2022-05-30T07:42:05.671Z' number_of_contacts: 1 last_updated_date: '2022-06-06T08:38:36.761Z' last_activity_date: '2022-06-06T08:38:36.000Z' next_activity_date: null number_of_activities: 0 linkedContactsIds: - 1 - 2 - 3 linkedCompaniesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 - id: 629475917295261d9b1f4403 attributes: deal_name: testname deal_owner: 6093d2425a9b436e9519d034 amount: 12 pipeline: 6093d296ad1e9c5cf2140a58 deal_stage: 9e577ff7-8e42-4ab3-be26-2b5e01b42518 stage_updated_at: '2022-05-30T07:42:05.671Z' created_at: '2022-05-30T07:42:05.671Z' number_of_contacts: 1 last_updated_date: '2022-06-06T08:38:36.761Z' last_activity_date: '2022-06-06T08:38:36.000Z' next_activity_date: null number_of_activities: 0 linkedContactsIds: - 1 - 2 - 3 linkedCompaniesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. post: tags: - Sales CRM > Deals summary: Create a deal requestBody: content: application/json: schema: type: object example: name: 'Deal: Connect with company' attributes: deal_owner: 6093d2425a9b436e9519d034 amount: 12 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 61a5cd07ca1347c82306ad06 '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /crm/deals/link-unlink/{id}: patch: tags: - Sales CRM > Deals summary: Link and Unlink a deal with contacts and companies requestBody: content: application/json: schema: type: object example: linkContactIds: - 1 - 2 - 3 unlinkContactIds: - 4 - 5 - 6 linkCompanyIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 unlinkCompanyIds: - 61a5ce58c5d4795761045994 - 61a5ce58c5d479576104595 - 61a5ce58c5d4795761045996 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. /crm/attributes/deals: get: tags: - Sales CRM > Deals summary: Get deal attributes parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - internalName: deal_name label: Deal Name attributeTypeName: text attributeOptions: - key: custom key value: custom label - key: custom key value: custom label isRequired: true - internalName: deal_name label: Deal Name attributeTypeName: text attributeOptions: - key: custom key value: custom label - key: custom key value: custom label isRequired: true /crm/deals/{id}: get: tags: - Sales CRM > Deals summary: Get a deal parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 629475917295261d9b1f4403 attributes: deal_name: testname deal_owner: 6093d2425a9b436e9519d034 amount: 12 pipeline: 6093d296ad1e9c5cf2140a58 deal_stage: 9e577ff7-8e42-4ab3-be26-2b5e01b42518 stage_updated_at: '2022-05-30T07:42:05.671Z' created_at: '2022-05-30T07:42:05.671Z' number_of_contacts: 1 last_updated_date: '2022-06-06T08:38:36.761Z' last_activity_date: '2022-06-06T08:38:36.000Z' next_activity_date: null number_of_activities: 0 linkedContactsIds: - 1 - 2 - 3 linkedCompaniesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found delete: tags: - Sales CRM > Deals summary: Delete a deal parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found patch: tags: - Sales CRM > Deals summary: Update a deal requestBody: content: application/json: schema: type: object example: name: 'Deal: Connect with client' attributes: deal_owner: 6093d2425a9b436e9519d034 amount: 12 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /crm/tasks: get: tags: - Sales CRM > Tasks summary: Get all tasks parameters: - name: Accept in: header schema: type: string example: application/json - name: filter[type] in: query schema: type: string description: Filter by task type (ID) - name: filter[status] in: query schema: type: string description: Filter by task status - name: filter[date] in: query schema: type: string description: Filter by date - name: filter[assignTo] in: query schema: type: string description: Filter by assignTo id - name: filter[contacts] in: query schema: type: string description: Filter by contact ids - name: filter[deals] in: query schema: type: string description: Filter by deals ids - name: filter[companies] in: query schema: type: string description: Filter by companies ids - name: dateFrom in: query schema: type: integer description: dateFrom to date range filter type (timestamp in milliseconds) example: '1677168398000' - name: dateTo in: query schema: type: integer description: dateTo to date range filter type (timestamp in milliseconds) example: '1677168398000' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed example: desc - name: sortBy in: query schema: type: string description: The field used to sort field names. example: name responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: items: - taskTypeId: 61a5cd07ca1347c82306ad09 name: 'Task: Connect with client' id: 61a5cd07ca1347c82306ad06 contactsIds: - 1 - 2 - 3 dealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 companiesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 - taskTypeId: 61a5cd07ca1347c82306ad09 name: 'Task: Connect with client' id: 61a5cd07ca1347c82306ad06 contactsIds: - 1 - 2 - 3 dealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 companiesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. post: tags: - Sales CRM > Tasks summary: Create a task requestBody: content: application/json: schema: type: object example: name: 'Task: Connect with client' taskTypeId: 61a5cd07ca1347c82306ad09 date: '2021-11-01T17:44:54.668Z' duration: 600000 notes: In communication with client for resolution of queries. done: false assignToId: 5faab4b7f195bb3c4c31e62a contactsIds: - 1 - 2 - 3 dealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 companiesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 reminder: value: 10 unit: days types: - email parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 61a5cd07ca1347c82306ad06 '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /crm/tasktypes: get: tags: - Sales CRM > Tasks summary: Get all task types parameters: - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 61a88a2eb7a574180261234 title: Email /crm/tasks/{id}: get: tags: - Sales CRM > Tasks summary: Get a task parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: taskTypeId: 61a5cd07ca1347c82306ad09 name: 'Task: Connect with client' id: 61a5cd07ca1347c82306ad06 contactsIds: - 1 - 2 - 3 dealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 companiesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found delete: tags: - Sales CRM > Tasks summary: Delete a task parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found patch: tags: - Sales CRM > Tasks summary: Update a task requestBody: content: application/json: schema: type: object example: name: 'Task: Connect with client' duration: 600000 taskTypeId: 61a5cd07ca1347c82306ad09 date: '2021-11-01T17:44:54.668Z' notes: In communication with client for resolution of queries. done: false assignToId: 5faab4b7f195bb3c4c31e62a contactsIds: - 1 - 2 - 3 dealsIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 companiesIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 - 61a5ce58c5d4795761045992 reminder: value: 10 unit: minutes types: - email parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: '(Required) ' responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /crm/notes: get: tags: - Sales CRM > Notes summary: Get all notes parameters: - name: Accept in: header schema: type: string example: application/json - name: entity in: query schema: type: string description: Filter by note entity type example: deals - name: entityIds in: query schema: type: string description: Filter by note entity IDs - name: dateFrom in: query schema: type: integer description: dateFrom to date range filter type (timestamp in milliseconds) example: '1677168398000' - name: dateTo in: query schema: type: integer description: dateTo to date range filter type (timestamp in milliseconds) example: '1677254798000' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - text: In communication with client for resolution of queries. id: 61a5cd07ca1347c82306ad09 contactIds: - 247 - 1 - 2 dealIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 authorId: email: johndoe@example.com locale: en_GB timezone: Asia/Kolkata name: fullName: John Doe createdAt: '2017-05-01T17:05:03.000Z' updatedAt: '2017-05-01T17:05:03.000Z' - text: In communication with client for resolution of queries. id: 61a5cd07ca1347c82306ad09 contactIds: - 247 - 1 - 2 dealIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 authorId: email: johndoe@example.com locale: en_GB timezone: Asia/Kolkata name: fullName: John Doe createdAt: '2017-05-01T17:05:03.000Z' updatedAt: '2017-05-01T17:05:03.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. post: tags: - Sales CRM > Notes summary: Create a note requestBody: content: application/json: schema: type: object example: text: In communication with client for resolution of queries. contactIds: - 247 - 1 - 2 dealIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 companyIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 61a5cd07ca1347c82306ad09 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: The format not supported for deserialization. /crm/notes/{id}: get: tags: - Sales CRM > Notes summary: Get a note parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Note ID to get responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: text: In communication with client for resolution of queries. id: 61a5cd07ca1347c82306ad09 contactIds: - 247 - 1 - 2 dealIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 authorId: email: johndoe@example.com locale: en_GB timezone: Asia/Kolkata name: fullName: John Doe createdAt: '2017-05-01T17:05:03.000Z' updatedAt: '2017-05-01T17:05:03.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found patch: tags: - Sales CRM > Notes summary: Update a note requestBody: content: application/json: schema: type: object example: text: In communication with client for resolution of queries. contactIds: - 247 - 1 - 2 dealIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 companyIds: - 61a5ce58c5d4795761045990 - 61a5ce58c5d4795761045991 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Note ID to update responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found '415': description: Unsupported Media Type headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: The format not supported for deserialization. delete: tags: - Sales CRM > Notes summary: Delete a note parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Note ID to delete responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid. '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /crm/files: get: tags: - Sales CRM > Files summary: Get all files parameters: - name: Accept in: header schema: type: string example: application/json - name: entity in: query schema: type: string description: Filter by file entity type example: deals - name: entityIds in: query schema: type: string description: Filter by file entity IDs - name: dateFrom in: query schema: type: integer description: dateFrom to date range filter type (timestamp in milliseconds) example: '1677168398000' - name: dateTo in: query schema: type: integer description: dateTo to date range filter type (timestamp in milliseconds) example: '1677254798000' - name: offset in: query schema: type: integer description: Index of the first document of the page example: '0' - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order. Default order is **descending** by creation if `sort` is not passed example: desc responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: - name: example.png authorId: 61a5ce58y5d4795761045991 contactId: 1 dealId: 61a5ce58c5d4795761045991 companyId: 61a5ce58c5d4795761045991 size: 10 createdAt: '2017-05-01T17:05:03.000Z' - name: example.png authorId: 61a5ce58y5d4795761045991 contactId: 1 dealId: 61a5ce58c5d4795761045991 companyId: 61a5ce58c5d4795761045991 size: 10 createdAt: '2017-05-01T17:05:03.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Not valid data. post: tags: - Sales CRM > Files summary: Upload a file requestBody: content: multipart/form-data: schema: type: object properties: file: type: string description: (Required) File data to create a file. format: binary dealId: type: string example: proident contactId: type: integer example: '27165486' companyId: type: integer example: '271654863' parameters: - name: Content-Type in: header schema: type: string example: multipart/form-data - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: name: example.png authorId: 61a5ce58y5d4795761045991 contactId: 1 dealId: 61a5ce58c5d4795761045991 companyId: 61a5ce58c5d4795761045991 size: 10 createdAt: '2017-05-01T17:05:03.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Invalid deals ids format. /crm/files/{id}: get: tags: - Sales CRM > Files summary: Download a file parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) File id to download. responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: fileUrl: >- https://storage.googleapis.com/sendinblue-app-crm.......-sample.pdf '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found delete: tags: - Sales CRM > Files summary: Delete a file parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) File id to delete. responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /crm/files/{id}/data: get: tags: - Sales CRM > Files summary: Get file details parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) File id to get file data. responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: name: example.png authorId: 61a5ce58y5d4795761045991 contactId: 1 dealId: 61a5ce58c5d4795761045991 companyId: 61a5ce58c5d4795761045991 size: 10 createdAt: '2017-05-01T17:05:03.000Z' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Route attribute id is not valid '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: message: Document not found /conversations/messages: post: tags: - Conversations > Messages summary: Send a message as an agent requestBody: content: application/json: schema: type: object example: visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg text: Hello! How can I help you? agentId: d9nKoegKSjmCtyK78 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: eYBEm3gq3zc5ayE2g type: agent text: Hello! How can I help you? visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1482512803740 receivedFrom: SuperAwesomeHelpdesk '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /conversations/messages/{id}: get: tags: - Conversations > Messages summary: Get a message parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) ID of the message responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: eYBEm3gq3zc5ayE2g type: agent text: Hello! How can I help you? visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1482512803740 receivedFrom: SuperAwesomeHelpdesk '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Conversations > Messages summary: Update a message sent by an agent description: Only agents’ messages can be edited. requestBody: content: application/json: schema: type: object example: text: Good morning! How can I help you? parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) ID of the message responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: eYBEm3gq3zc5ayE2g type: agent text: Hello! How can I help you? visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1482512803740 receivedFrom: SuperAwesomeHelpdesk '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Conversations > Messages summary: Delete a message sent by an agent description: Only agents’ messages can be deleted. parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) ID of the message responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /conversations/agentOnlinePing: post: tags: - Conversations > Status summary: Sets agent’s status to online for 2-3 minutes description: >- We recommend pinging this endpoint every minute for as long as the agent has to be considered online. requestBody: content: application/json: schema: type: object example: agentId: d9nKoegKSjmCtyK78 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /conversations/pushedMessages: post: tags: - Conversations > Pushed messages summary: Send an automated message to a visitor description: >- Example of automated messages: order status, announce new features in your web app, etc. requestBody: content: application/json: schema: type: object example: visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg text: >- Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: AXCR3k9bpSY7bpuh7 type: agent text: >- Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88 visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1470222622433 isPushed: true '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /conversations/pushedMessages/{id}: get: tags: - Conversations > Pushed messages summary: Get an automated message parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) ID of the message sent previously responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: AXCR3k9bpSY7bpuh7 type: agent text: >- Your order has shipped! Here’s your tracking number: 9114 5847 3325 9667 4328 88 visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1470222622433 isPushed: true '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path put: tags: - Conversations > Pushed messages summary: Update an automated message requestBody: content: application/json: schema: type: object example: text: >- Your order has shipped! Here’s your tracking number: 9114 5847 4668 7775 9233 54 parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) ID of the message responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: AXCR3k9bpSY7bpuh7 type: agent text: >- Your order has shipped! Here’s your tracking number: 9114 5847 4668 7775 9233 54 visitorId: kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg agentId: d9nKoegKSjmCtyK78 createdAt: 1470222622433 isPushed: true '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path delete: tags: - Conversations > Pushed messages summary: Delete an automated message parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /orders/status: get: tags: - eCommerce > Orders summary: Create/update an order responses: '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /orders/status/batch: post: tags: - eCommerce > Orders summary: Create orders in batch requestBody: content: application/json: schema: type: object example: orders: - id: '14' createdAt: '2021-07-29T20:59:23.383Z' updatedAt: '2021-07-30T10:59:23.383Z' status: completed amount: 308.42 products: - value: '' - value: '' email: example@sendinblue.com billing: address: value: '' city: value: '' countryCode: value: '' phone: value: '' postCode: value: '' paymentMethod: value: '' region: value: '' coupons: - EASTER15OFF - id: '14' createdAt: '2021-07-29T20:59:23.383Z' updatedAt: '2021-07-30T10:59:23.383Z' status: completed amount: 308.42 products: - value: '' - value: '' email: example@sendinblue.com billing: address: value: '' city: value: '' countryCode: value: '' phone: value: '' postCode: value: '' paymentMethod: value: '' region: value: '' coupons: - EASTER15OFF notifyUrl: https://en.wikipedia.org/wiki/Webhook parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '202': description: Accepted headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: batchId: 67473922.20865113 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /categories: get: tags: - eCommerce > Categories summary: Get all categories parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc - name: ids in: query schema: type: string description: Filter by category ids example: ' ' responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: categories: - id: 19 name: Food url: http://mydomain.com/cagetory/food modifiedAt: '2022-03-03T14:48:31.867Z' createdAt: '2021-12-31T11:42:35.638Z' - id: 20 name: clothing url: http://mydomain.com/cagetory/clothing modifiedAt: '2022-03-03T14:48:31.867Z' createdAt: '2021-12-31T11:42:35.638Z' count: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - eCommerce > Categories summary: Create/update a category requestBody: content: application/json: schema: type: object example: id: 4ym78sfr8@VaAMB.xgn name: Electronics url: http://mydomain.com/category/electronics updateEnabled: false parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 21 '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /categories/batch: post: tags: - eCommerce > Categories summary: Create categories in batch requestBody: content: application/json: schema: type: object example: categories: - id: cI5vQG@akAvYs.aakp name: Electronics url: http://mydomain.com/category/electronics - id: lw76jTxBp@ZL.vlo name: Electronics url: http://mydomain.com/category/electronics updateEnabled: true parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: createdCount: 2 updatedCount: 7 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /categories/{id}: get: tags: - eCommerce > Categories summary: Get a category details parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Category ID responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: C11 name: Electronics createdAt: '2017-05-12T12:30:00.000Z' modifiedAt: '2017-05-12T12:30:00.000Z' url: http://mydomain.com/cagetory/clothing '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /products: get: tags: - eCommerce > Products summary: Get all products parameters: - name: Accept in: header schema: type: string example: application/json - name: limit in: query schema: type: integer description: Number of documents per page example: '50' - name: offset in: query schema: type: integer description: Index of the first document in the page example: '0' - name: sort in: query schema: type: string description: >- Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed example: desc - name: ids in: query schema: type: string description: Filter by product ids responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: products: - id: 7498033266862 name: Alpina Panoma Classic url: https://mydomain.com/products/alpina-panoma-classic sku: 186622-9 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg categories: - '279638835374' - '279502848174' price: 49.95 modifiedAt: '2022-06-30T10:29:16.078Z' createdAt: '2022-06-30T10:29:16.078Z' s3Original: https://img-ecom.mailinblue.com/path-to-original/img.jpg s3ThumbAnalytics: https://img-ecom.mailinblue.com/path-to-analytics/img.jpg s3ThumbEditor: https://img-ecom.mailinblue.com/path-to-editor/img.jpg - id: 7498033266862 name: Alpina Panoma Classic2 url: https://mydomain.com/products/alpina-panoma-classic2 sku: 186622-9 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg categories: - 2d79638835374 - 27d9502848174 price: 49.95 metaInfo: description: Shoes for sports brand: addidas modifiedAt: '2022-06-30T10:29:16.078Z' createdAt: '2022-06-30T10:29:16.078Z' s3Original: https://img-ecom.mailinblue.com/path-to-original/img.jpg s3ThumbAnalytics: https://img-ecom.mailinblue.com/path-to-analytics/img.jpg s3ThumbEditor: https://img-ecom.mailinblue.com/path-to-editor/img.jpg count: 2 '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path post: tags: - eCommerce > Products summary: Create/update a product requestBody: content: application/json: schema: type: object example: id: P11 name: IPhone 11 url: http://mydomain.com/product/electronics/product1 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg sku: SKU523452235 price: -48445562.575949855 categories: - id - v parentId: minim amet metaInfo: description: Shoes for sports brand: addidas updateEnabled: false parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: 21 '204': description: No Content headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /products/{id}: get: tags: - eCommerce > Products summary: Get a product's details parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: (Required) Product ID responses: '200': description: OK headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: id: P11 name: Iphone 11 createdAt: '2017-05-12T12:30:00.000Z' modifiedAt: '2017-05-12T12:30:00.000Z' s3ThumbAnalytics: irure eiusmod ut est s3ThumbEditor: enim incididunt url: http://mydomain.com/product/electronics/product1 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg sku: dolore officia sit price: 61347100.411326766 categories: - dolore eiusmod exercitation - in parentId: Excepteur irure minim s3Original: consectetur velit cillum metaInfo: description: Shoes for sports brand: addidas '400': description: Bad Request headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path '404': description: Not Found headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: code: method_not_allowed message: POST Method is not allowed on this path /products/batch: post: tags: - eCommerce > Products summary: Create products in batch requestBody: content: application/json: schema: type: object example: products: - id: P11 name: Iphone 11 url: http://mydomain.com/product/electronics/product1 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg sku: SKU5234522331 price: 9965553.347645134 categories: - value: '' - value: '' parentId: GH56214 metaInfo: description: Shoes for sports brand: adidas - id: P11 name: Iphone 11 url: http://mydomain.com/product/electronics/product1 imageUrl: http://mydomain.com/product-absoulte-url/img.jpeg sku: SKU523452235 price: -2971697.3335331976 categories: - value: '' - value: '' parentId: HG3561 metaInfo: description: Shoes for sports brand: addidas updateEnabled: false parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '201': description: Created headers: Content-Type: schema: type: string example: application/json content: application/json: schema: type: object example: createdCount: 2 updatedCount: 7 '400': description: Bad Request headers: Content-Type: schema: type: string example: text/plain content: text/plain: schema: type: string example: '' /v3/ecommerce/activate: post: tags: - eCommerce summary: Activate eCommerce platform on your account requestBody: content: {} responses: '200': description: Successful response content: application/json: {} /couponCollections: get: tags: - Coupons summary: Get a coupon collection by id parameters: - name: Accept in: header schema: type: string example: application/json - name: id in: query schema: type: string responses: '200': description: Successful response content: application/json: {} post: tags: - Coupons summary: Create a coupon collection requestBody: content: '*/*': schema: type: string example: >- "{\n \"name\": \"SummerPromotions\",\n \"defaultCoupon\": \"10 OFF\"\n}" parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /couponCollections/{id}: patch: tags: - Coupons summary: Update a coupon collection by id requestBody: content: '*/*': schema: type: string example: >- "{\n \"coupons\": [\n \"udsfhds\",\n \"asgr\",\n \"sdg4iinas\",\n \"asdgn4ou\"\n ],\n \"collectionId\": \"2620197b-505f-407f-9bd2-64e16f29fb53\"\n}\n'" parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json - name: id in: path schema: type: string required: true description: |+ Id of the collection to update responses: '200': description: Successful response content: application/json: {} /coupons: post: tags: - Coupons summary: Create coupons for a coupon collection requestBody: content: {} parameters: - name: Content-Type in: header schema: type: string example: application/json - name: Accept in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /api/v2/identifyUser: post: tags: - Events > Automation Tracker summary: Identify the user requestBody: content: {} security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /api/v2/TrackEvent: post: tags: - Events > Automation Tracker summary: Track event requestBody: content: {} security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /api/v2/TrackLink: post: tags: - Events > Automation Tracker summary: Track link clicks requestBody: content: {} security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {} /api/v2/TrackPage: post: tags: - Events > Automation Tracker summary: Track page views requestBody: content: {} security: - apikeyAuth: [] parameters: - name: Accept in: header schema: type: string example: application/json - name: Content-Type in: header schema: type: string example: application/json responses: '200': description: Successful response content: application/json: {}