--- swagger: "2.0" info: description: "Brevo provide a RESTFul API that can be used with any languages. With\ \ this API, you will be able to :\n - Manage your campaigns and get the statistics\n\ \ - Manage your contacts\n - Send transactional Emails and SMS\n - and much\ \ more...\n\nYou can download our wrappers at https://github.com/orgs/brevo\n\n\ **Possible responses**\n | Code | Message |\n | :-------------: | -------------\ \ |\n | 200 | OK. Successful Request |\n | 201 | OK. Successful Creation\ \ |\n | 202 | OK. Request accepted |\n | 204 | OK. Successful Update/Deletion\ \ |\n | 400 | Error. Bad Request |\n | 401 | Error. Authentication Needed\ \ |\n | 402 | Error. Not enough credit, plan upgrade needed |\n | 403 |\ \ Error. Permission denied |\n | 404 | Error. Object does not exist |\n |\ \ 405 | Error. Method not allowed |\n | 406 | Error. Not Acceptable |\n" version: "3.0.0" title: "Brevo API" contact: name: "Brevo Support" url: "https://account.brevo.com/support" email: "contact@brevo.com" license: name: "MIT" url: "http://opensource.org/licenses/MIT" host: "api.brevo.com" basePath: "/v3" schemes: - "https" consumes: - "application/json" produces: - "application/json" security: - api-key: [] - partner-key: [] paths: /emailCampaigns: get: tags: - "Email Campaigns" summary: "Return all your created email campaigns" operationId: "getEmailCampaigns" parameters: - name: "type" in: "query" description: "Filter on the type of the campaigns" required: false type: "string" enum: - "classic" - "trigger" x-exportParamName: "Type_" x-optionalDataType: "String" - name: "status" in: "query" description: "Filter on the status of the campaign" required: false type: "string" enum: - "suspended" - "archive" - "sent" - "queued" - "draft" - "inProcess" x-exportParamName: "Status" x-optionalDataType: "String" - name: "statistics" in: "query" description: "Filter on the type of statistics required. Example **globalStats**\ \ value will only fetch globalStats info of the campaign in returned response." required: false type: "string" enum: - "globalStats" - "linksStats" - "statsByDomain" x-exportParamName: "Statistics" x-optionalDataType: "String" - name: "startDate" in: "query" 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' )" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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' )" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 100 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "excludeHtmlContent" in: "query" description: "Use this flag to exclude htmlContent from the response body.\ \ If set to **true**, htmlContent field will be returned as empty string\ \ in the response body" required: false type: "boolean" enum: - "true" - "false" x-exportParamName: "ExcludeHtmlContent" x-optionalDataType: "Bool" responses: "200": description: "Email campaigns informations" examples: applications/json: campaigns: - id: 12 name: "EN - Sales Summer 2017" subject: "20% OFF for 2017 Summer Sales" type: "classic" status: "sent" scheduledAt: "2017-06-01T12:30:00Z" 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:00Z" modifiedAt: "2017-05-01T12:30:00Z" 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: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 unsubscriptions: 2 viewed: 8999 deferred: 30 gmail: uniqueClicks: 2300 clickers: 2665 complaints: 1 delivered: 19765 sent: 19887 softBounces: 100 hardBounces: 87 uniqueViews: 7779 unsubscriptions: 2 viewed: 8999 deferred: 30 - 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:00Z" modifiedAt: "2017-05-01T12:30:00Z" 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: 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 count: 2 schema: $ref: "#/definitions/getEmailCampaigns" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Email Campaigns" summary: "Create an email campaign" operationId: "createEmailCampaign" parameters: - in: "body" name: "emailCampaigns" description: "Values to create a campaign" required: true schema: $ref: "#/definitions/createEmailCampaign" x-exportParamName: "EmailCampaigns" responses: "201": description: "Email campaign created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}: get: tags: - "Email Campaigns" summary: "Get an email campaign report" operationId: "getEmailCampaign" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - name: "statistics" in: "query" description: "Filter on the type of statistics required. Example **globalStats**\ \ value will only fetch globalStats info of the campaign in returned response." required: false type: "string" enum: - "globalStats" - "linksStats" - "statsByDomain" - "statsByDevice" - "statsByBrowser" x-exportParamName: "Statistics" x-optionalDataType: "String" responses: "200": description: "Email campaign informations" examples: application/json: id: 22 name: "Weekly - 1" subject: "Week 1 - Newsletter" type: "classic" status: "draft" scheduledAt: "2017-09-22T12:30:00Z" 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.brevo.com/fhsgccc.html?t=9865448900" tag: "Newsletter" createdAt: "2017-05-01T12:30:00Z" modifiedAt: "2017-05-01T12:30:00Z" 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 schema: $ref: "#/definitions/getEmailCampaign" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Email Campaigns" summary: "Update an email campaign" operationId: "updateEmailCampaign" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "emailCampaign" description: "Values to update a campaign" required: true schema: $ref: "#/definitions/updateEmailCampaign" x-exportParamName: "EmailCampaign" responses: "204": description: "Email Campaign has been updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Email Campaigns" summary: "Delete an email campaign" operationId: "deleteEmailCampaign" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "204": description: "Email campaign has been deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/sendNow: post: tags: - "Email Campaigns" summary: "Send an email campaign immediately, based on campaignId" operationId: "sendEmailCampaignNow" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "204": description: "Email campaign has been scheduled" "400": description: "Campaign could not be sent" schema: $ref: "#/definitions/errorModel" "402": description: "You don't have enough credit to send your campaign. Please\ \ update your plan" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/sendTest: post: tags: - "Email Campaigns" summary: "Send an email campaign to your test list" operationId: "sendTestEmail" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "emailTo" required: true schema: $ref: "#/definitions/sendTestEmail" x-exportParamName: "EmailTo" responses: "204": description: "Test email has been sent successfully to all recipients" "400": description: "Test email could not be sent to the following email addresses" schema: $ref: "#/definitions/postSendFailed" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/status: put: tags: - "Email Campaigns" summary: "Update an email campaign status" operationId: "updateCampaignStatus" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "status" description: "Status of the campaign" required: true schema: $ref: "#/definitions/updateCampaignStatus" x-exportParamName: "Status" responses: "204": description: "The campaign status has been updated successfully" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/sendReport: post: tags: - "Email Campaigns" summary: "Send the report of a campaign" description: "A PDF will be sent to the specified email addresses" operationId: "sendReport" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "sendReport" description: "Values for send a report" required: true schema: $ref: "#/definitions/sendReport" x-exportParamName: "SendReport" responses: "204": description: "Report has been successfully sent to the defined recipients" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/abTestCampaignResult: get: tags: - "Email Campaigns" summary: "Get an A/B test email campaign results" description: "Obtain winning version of an A/B test email campaign" operationId: "getAbTestCampaignResult" parameters: - name: "campaignId" in: "path" description: "Id of the A/B test campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "200": description: "A/B test email campaign Result" examples: application/json: 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: "http://www.google.com" clicksCount: 0 clickRate: "0%" - link: "http://www.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%" schema: $ref: "#/definitions/abTestCampaignResult" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "A/B test Email Campaign not found" schema: $ref: "#/definitions/errorModel" "405": description: "Only email campaigns or templates are allowed" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/sharedUrl: get: tags: - "Email Campaigns" summary: "Get a shared template url" description: "Get a unique URL to share & import an email template from one\ \ Brevo account to another." operationId: "getSharedTemplateUrl" parameters: - name: "campaignId" in: "path" description: "Id of the campaign or template" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "200": description: "Shared template URL information" examples: application/json: sharedUrl: "https://my.brevo.com/pt2YU7R5W_guXlowgumy_VX4pFsKu._zd0Gjj96x1_GMmzc1Qps5ZIpj6nx-" schema: $ref: "#/definitions/getSharedTemplateUrl" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign/Template ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/{campaignId}/exportRecipients: post: tags: - "Email Campaigns" summary: "Export the recipients of an email campaign" operationId: "emailExportRecipients" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "recipientExport" description: "Values to send for a recipient export request" required: false schema: $ref: "#/definitions/emailExportRecipients" x-exportParamName: "RecipientExport" responses: "202": description: "Recipient export request has been accepted" schema: $ref: "#/definitions/createdProcessId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /emailCampaigns/images: post: tags: - "Email Campaigns" summary: "Upload an image to your account's image gallery" operationId: "uploadImageToGallery" parameters: - in: "body" name: "uploadImage" description: "Parameters to upload an image" required: true schema: $ref: "#/definitions/uploadImageToGallery" x-exportParamName: "UploadImage" responses: "201": description: "Image successfully uploaded" schema: $ref: "#/definitions/uploadImageModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/email: post: tags: - "Transactional emails" summary: "Send a transactional email" operationId: "sendTransacEmail" parameters: - in: "body" name: "sendSmtpEmail" description: "Values to send a transactional email" required: true schema: $ref: "#/definitions/sendSmtpEmail" x-exportParamName: "SendSmtpEmail" responses: "201": description: "transactional email sent" schema: $ref: "#/definitions/createSmtpEmail" "202": description: "transactional email scheduled" schema: $ref: "#/definitions/scheduleSmtpEmail" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/emails: get: tags: - "Transactional emails" 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." operationId: "getTransacEmailsList" parameters: - name: "email" in: "query" description: "Mandatory if templateId and messageId are not passed in query\ \ filters. Email address to which transactional email has been sent." required: false type: "string" x-exportParamName: "Email" x-optionalDataType: "String" - name: "templateId" in: "query" description: "Mandatory if email and messageId are not passed in query filters.\ \ Id of the template that was used to compose transactional email." required: false type: "integer" format: "int64" x-exportParamName: "TemplateId" x-optionalDataType: "Int64" - name: "messageId" in: "query" description: "Mandatory if templateId and email are not passed in query filters.\ \ Message ID of the transactional email sent." required: false type: "string" x-exportParamName: "MessageId" x-optionalDataType: "String" - name: "startDate" in: "query" 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." required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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." required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 500 maximum: 1000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" responses: "200": description: "List of transactional emails" examples: application/json: 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:26Z" - email: "test@test.com" subject: "details verification" templateId: 15 messageId: "<201798300811.5700093@relay.domain.com>" uuid: "5a78c-209ok98262910-s99a341" date: "2019-05-25T07:28:11Z" schema: $ref: "#/definitions/getTransacEmailsList" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/emails/{uuid}: get: tags: - "Transactional emails" summary: "Get the personalized content of a sent transactional email" operationId: "getTransacEmailContent" parameters: - name: "uuid" in: "path" description: "Unique id of the transactional email that has been sent to a\ \ particular contact" required: true type: "string" x-exportParamName: "Uuid" responses: "200": description: "Transactional email content" examples: application/json: email: "abc@example.com" subject: "Summer Camps" templateId: 12 date: "2016-02-25T11:53:26Z" events: - name: "sent" time: "2016-02-25T11:53:26Z" - name: "delivered" time: "2016-02-25T11:55:26Z" - name: "opened" time: "2016-02-26T09:53:26Z" body: "

Greetings from the team

\ \

This is the actual html content sent

" schema: $ref: "#/definitions/getTransacEmailContent" /smtp/log/{messageId}: delete: tags: - "Transactional emails" summary: "Delete an SMTP transactional log" parameters: - name: "messageId" in: "path" description: "MessageId of the transactional log to delete" required: true type: "string" x-exportParamName: "MessageId" responses: "204": description: "Transactional Logs deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Message ID not found" schema: $ref: "#/definitions/errorModel" /smtp/templates: get: tags: - "Transactional emails" summary: "Get the list of email templates" operationId: "getSmtpTemplates" parameters: - name: "templateStatus" in: "query" description: "Filter on the status of the template. Active = true, inactive\ \ = false" required: false type: "boolean" x-exportParamName: "TemplateStatus" x-optionalDataType: "Bool" - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 50 maximum: 1000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "transactional email templates informations" examples: application/json: 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:24Z" modifiedAt: "2016-02-24T15:37:11Z" - 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:26Z" modifiedAt: "2016-02-25T11:53:26Z" schema: $ref: "#/definitions/getSmtpTemplates" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Transactional emails" summary: "Create an email template" operationId: "createSmtpTemplate" parameters: - in: "body" name: "smtpTemplate" description: "values to update in transactional email template" required: true schema: $ref: "#/definitions/createSmtpTemplate" x-exportParamName: "SmtpTemplate" responses: "201": description: "transactional email template created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/templates/{templateId}: get: tags: - "Transactional emails" summary: "Returns the template information" operationId: "getSmtpTemplate" parameters: - name: "templateId" in: "path" description: "id of the template" required: true type: "integer" format: "int64" x-exportParamName: "TemplateId" responses: "200": description: "Email template informations" examples: application/json: 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:26Z" modifiedAt: "2016-02-25T11:53:26Z" doiTemplate: false schema: $ref: "#/definitions/getSmtpTemplateOverview" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Template ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Transactional emails" summary: "Update an email template" operationId: "updateSmtpTemplate" parameters: - name: "templateId" in: "path" description: "id of the template" required: true type: "integer" format: "int64" x-exportParamName: "TemplateId" - in: "body" name: "smtpTemplate" description: "values to update in transactional email template" required: true schema: $ref: "#/definitions/updateSmtpTemplate" x-exportParamName: "SmtpTemplate" responses: "204": description: "transactional email template updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Template ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Transactional emails" summary: "Delete an inactive email template" operationId: "deleteSmtpTemplate" parameters: - name: "templateId" in: "path" description: "id of the template" required: true type: "integer" format: "int64" x-exportParamName: "TemplateId" responses: "204": description: "Inactive transactional email template has been deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Template ID not found" schema: $ref: "#/definitions/errorModel" /smtp/templates/{templateId}/sendTest: post: tags: - "Transactional emails" summary: "Send a template to your test list" operationId: "sendTestTemplate" parameters: - name: "templateId" in: "path" description: "Id of the template" required: true type: "integer" format: "int64" x-exportParamName: "TemplateId" - in: "body" name: "sendTestEmail" required: true schema: $ref: "#/definitions/sendTestEmail" x-exportParamName: "SendTestEmail" responses: "204": description: "Test email has been sent successfully to all recipients" "400": description: "Test email could not be sent to the following email addresses" schema: $ref: "#/definitions/postSendFailed" "404": description: "Template ID not found" schema: $ref: "#/definitions/errorModel" /smtp/statistics/aggregatedReport: get: tags: - "Transactional emails" 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" operationId: "getAggregatedSmtpReport" parameters: - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD).\ \ Must be lower than equal to endDate" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD).\ \ Must be greater than equal to startDate" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with 'startDate' and 'endDate'" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "tag" in: "query" description: "Tag of the emails" required: false type: "string" x-exportParamName: "Tag" x-optionalDataType: "String" responses: "200": description: "Aggregated report informations" examples: application/json: 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 schema: $ref: "#/definitions/getAggregatedReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/statistics/reports: get: tags: - "Transactional emails" summary: "Get your transactional email activity aggregated per day" operationId: "getSmtpReport" parameters: - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 10 maximum: 30 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document on the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD)" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD)" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with 'startDate' and 'endDate'" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "tag" in: "query" description: "Tag of the emails" required: false type: "string" x-exportParamName: "Tag" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Aggregated report informations" examples: application/json: reports: - date: "2017-04-30" 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-01" requests: 18812 delivered: 17499 hardBounces: 34 softBounces: 254 clicks: 1514 uniqueClicks: 1090 opens: 10089 uniqueOpens: 4393 spamReports: 0 blocked: 920 invalid: 2 unsubscribed: 3 schema: $ref: "#/definitions/getReports" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/statistics/events: get: tags: - "Transactional emails" 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" operationId: "getEmailEventReport" parameters: - name: "limit" in: "query" description: "Number limitation for the result returned" required: false type: "integer" default: 2500 maximum: 5000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Beginning point in the list to retrieve from." required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date of the report (YYYY-MM-DD).\ \ Must be lower than equal to endDate" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD).\ \ Must be greater than equal to startDate" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with 'startDate' and 'endDate'" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "email" in: "query" description: "Filter the report for a specific email addresses" required: false type: "string" format: "email" x-exportParamName: "Email" x-optionalDataType: "String" - name: "event" in: "query" description: "Filter the report for a specific event type" required: false type: "string" enum: - "bounces" - "hardBounces" - "softBounces" - "delivered" - "spam" - "requests" - "opened" - "clicks" - "invalid" - "deferred" - "blocked" - "unsubscribed" - "error" - "loadedByProxy" x-exportParamName: "Event" x-optionalDataType: "String" - name: "tags" in: "query" description: "Filter the report for tags (serialized and urlencoded array)" required: false type: "string" x-exportParamName: "Tags" x-optionalDataType: "String" - name: "messageId" in: "query" description: "Filter on a specific message id" required: false type: "string" x-exportParamName: "MessageId" x-optionalDataType: "String" - name: "templateId" in: "query" description: "Filter on a specific template id" required: false type: "integer" format: "int64" x-exportParamName: "TemplateId" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Email events report informations" examples: application/json: events: - email: "john.smith@example.com" date: "2017-03-12T12:30:00Z" 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:00Z" messageId: "<201798300811.5787683@example.domain.com>" event: "delivered" tag: "OrderConfirmation" from: "john@example.com" templateId: 5 schema: $ref: "#/definitions/getEmailEventReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/blockedContacts/{email}: delete: tags: - "Transactional emails" summary: "Unblock or resubscribe a transactional contact" parameters: - name: "email" in: "path" description: "contact email (urlencoded) to unblock." required: true type: "string" x-exportParamName: "Email" responses: "204": description: "Contact unblocked" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Contact email not found" schema: $ref: "#/definitions/errorModel" /smtp/blockedContacts: get: tags: - "Transactional emails" summary: "Get the list of blocked or unsubscribed transactional contacts" operationId: "getTransacBlockedContacts" parameters: - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date (YYYY-MM-DD) from\ \ which you want to fetch the blocked or unsubscribed contacts" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date (YYYY-MM-DD) till\ \ which you want to fetch the blocked or unsubscribed contacts" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 50 maximum: 100 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document on the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "senders" in: "query" description: "Comma separated list of emails of the senders from which contacts\ \ are blocked or unsubscribed" required: false type: "array" items: type: "string" collectionFormat: "csv" x-exportParamName: "Senders" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "List of blocked or unsubscribed transactional contacts" examples: application/json: contacts: - email: "abc@xyz.com" senderEmail: "ez312@gmal.com" reason: message: "Admin blocked" code: "adminBlocked" blockedAt: "2017-05-01T12:30:00Z" count: 1 schema: $ref: "#/definitions/getTransacBlockedContacts" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/blockedDomains: get: tags: - "Transactional emails" summary: "Get the list of blocked domains" description: "Get the list of blocked domains" operationId: "getBlockedDomains" parameters: [] responses: "200": description: "List of blocked domains" examples: application/json: domains: - "example.com" - "testdomain.com" schema: $ref: "#/definitions/getBlockedDomains" post: tags: - "Transactional emails" 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" operationId: "blockNewDomain" parameters: - in: "body" name: "blockDomain" required: true schema: $ref: "#/definitions/blockDomain" x-exportParamName: "BlockDomain" responses: "201": description: "Domain is successfully blocked" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/blockedDomains/{domain}: delete: tags: - "Transactional emails" summary: "Unblock an existing domain from the list of blocked domains" description: "Unblocks an existing domain from the list of blocked domains" operationId: "deleteBlockedDomain" parameters: - name: "domain" in: "path" description: "The name of the domain to be deleted" required: true type: "string" x-exportParamName: "Domain" responses: "204": description: "Domain is successfully deleted from the list of blocked domains" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Domain not found" /smtp/deleteHardbounces: post: tags: - "Transactional emails" summary: "Delete hardbounces" description: "Delete hardbounces. To use carefully (e.g. in case of temporary\ \ ISP failures)" operationId: "deleteHardbounces" parameters: - in: "body" name: "deleteHardbounces" description: "values to delete hardbounces" required: false schema: $ref: "#/definitions/deleteHardbounces" x-exportParamName: "DeleteHardbounces" responses: "204": description: "Hardbounces deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smtp/emailStatus/{batchId}: get: tags: - "Transactional emails" summary: "Fetch scheduled emails by batchId" description: "Fetch scheduled batch of emails by batchId (Can retrieve data\ \ upto 30 days old)" operationId: "getScheduledEmailByBatchId" parameters: - name: "batchId" in: "path" description: "The batchId of scheduled emails batch (Should be a valid UUIDv4)" required: true type: "string" x-exportParamName: "BatchId" - name: "startDate" in: "query" 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." required: false type: "string" format: "date" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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." required: false type: "string" format: "date" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "status" in: "query" description: "Filter the records by `status` of the scheduled email batch\ \ or message." required: false type: "string" enum: - "processed" - "inProgress" - "queued" x-exportParamName: "Status" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 100 maximum: 500 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document on the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" responses: "200": description: "Scheduled email batches" examples: application/json: 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" schema: $ref: "#/definitions/getScheduledEmailByBatchId" "400": description: "Invalid parameters passed" schema: $ref: "#/definitions/errorModel" "404": description: "Records for batchId not found" schema: $ref: "#/definitions/errorModel" /smtp/emailStatus/{messageId}: get: tags: - "Transactional emails" summary: "Fetch scheduled email by messageId" description: "Fetch scheduled email by messageId (Can retrieve data upto 30\ \ days old)" operationId: "getScheduledEmailByMessageId" parameters: - name: "messageId" in: "path" description: "The messageId of scheduled email" required: true type: "string" x-exportParamName: "MessageId" - name: "startDate" in: "query" 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." required: false type: "string" format: "date" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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." required: false type: "string" format: "date" x-exportParamName: "EndDate" x-optionalDataType: "String" responses: "200": description: "Scheduled email" examples: application/json: scheduledAt: "2022-02-28T11:36:43.576000000Z" createdAt: "2022-02-26T11:36:43.576000000Z" status: "queued" schema: $ref: "#/definitions/getScheduledEmailByMessageId" "400": description: "Invalid parameters passed" schema: $ref: "#/definitions/errorModel" "404": description: "Record for messageId not found" schema: $ref: "#/definitions/errorModel" /smtp/email/{identifier}: delete: tags: - "Transactional emails" summary: "Delete scheduled emails by batchId or messageId" description: "Delete scheduled batch of emails by batchId or single scheduled\ \ email by messageId" operationId: "deleteScheduledEmailById" parameters: - name: "identifier" in: "path" description: "The `batchId` of scheduled emails batch (Should be a valid UUIDv4)\ \ or the `messageId` of scheduled email." required: true type: "string" x-exportParamName: "Identifier" responses: "204": description: "Scheduled email(s) deleted" "400": description: "Invalid parameters passed" schema: $ref: "#/definitions/errorModel" "404": description: "Record(s) for identifier not found" schema: $ref: "#/definitions/errorModel" /contacts: get: tags: - "Contacts" summary: "Get all the contacts" operationId: "getContacts" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 1000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "modifiedSince" in: "query" 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." required: false type: "string" x-exportParamName: "ModifiedSince" x-optionalDataType: "String" - name: "createdSince" in: "query" description: "Filter (urlencoded) the contacts created after a given UTC date-time\ \ (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to pass your timezone in date-time\ \ format for accurate result." required: false type: "string" x-exportParamName: "CreatedSince" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "All contacts listed" examples: application/json: contacts: - email: "contact1@example.com" id: 247 emailBlacklisted: true smsBlacklisted: true createdAt: "2017-05-01T17:05:03Z" modifiedAt: "2017-05-01T17:05:03Z" listIds: - 43 - 58 attributes: SMS: "33058407250" IDENTIFICATION: "1-3RHQ-259" CIV: "MS" LAST_NAME: "Brennon" FIRST_NAME: "Meg" DOB: "1986-05-02" 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:03Z" modifiedAt: "2017-05-01T17:05:03Z" listIds: - 43 - 61 - 58 attributes: SMS: "33058407248" IDENTIFICATION: "1-78JS-432" CIV: "MS" LAST_NAME: "Press" FIRST_NAME: "Sophia" DOB: "1980-09-11" ADDRESS: "5 Flower Street" ZIP_CODE: "44119" CITY: "Seattle" ACTION_CODE: "17HU765" count: 3 schema: $ref: "#/definitions/getContacts" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Contacts" summary: "Create a contact" operationId: "createContact" parameters: - in: "body" name: "createContact" description: "Values to create a contact" required: true schema: $ref: "#/definitions/createContact" x-exportParamName: "CreateContact" responses: "201": description: "Contact created" schema: $ref: "#/definitions/createUpdateContactModel" "204": description: "Contact updated" examples: application/json: {} "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/doubleOptinConfirmation: post: tags: - "Contacts" summary: "Create Contact via DOI (Double-Opt-In) Flow" operationId: "createDoiContact" parameters: - in: "body" name: "createDoiContact" description: "Values to create the Double opt-in (DOI) contact" required: true schema: $ref: "#/definitions/createDoiContact" x-exportParamName: "CreateDoiContact" responses: "201": description: "DOI Contact created" "204": description: "DOI Contact updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/{identifier}: get: tags: - "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.brevo.com/reference/contacts-7#getcontactstats)\ \ endpoint with the appropriate date ranges." operationId: "getContactInfo" parameters: - name: "identifier" in: "path" description: "Email (urlencoded) OR ID of the contact OR its SMS attribute\ \ value" required: true type: "string" x-exportParamName: "Identifier" - name: "startDate" in: "query" 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\n" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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.\n" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" responses: "200": description: "Contact informations" examples: application/json: email: "peggy.rain@example.com" id: 42 emailBlacklisted: false smsBlacklisted: false createdAt: "2017-05-02T16:40:31Z" modifiedAt: "2017-05-02T16:40:31Z" attributes: FIRST_NAME: "Peggy" LAST_NAME: "Rain" SMS: "3087433387669" CIV: "1" DOB: "1986-04-13" ADDRESS: "987 5th avenue" ZIP_CODE: "87544" CITY: "New-York" AREA: "NY" listIds: - 40 statistics: messagesSent: - campaignId: 21 eventTime: "2016-05-03T20:15:13Z" - campaignId: 42 eventTime: "2016-10-17T10:30:01Z" opened: - campaignId: 21 count: 2 eventTime: "2016-05-03T21:24:56Z" ip: "66.249.93.118" - campaignId: 68 count: 1 eventTime: "2017-01-30T13:56:40Z" ip: "66.249.93.217" clicked: - campaignId: 21 links: - count: 2 eventTime: "2016-05-03T21:25:01Z" ip: "66.249.93.118" url: "https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=brevo&utm_campaign=test_camp&utm_medium=email" delivered: - campaignId: 21 eventTime: "2016-05-03T20:15:13Z" schema: $ref: "#/definitions/getExtendedContactDetails" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Contact's email not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Contacts" summary: "Update a contact" operationId: "updateContact" parameters: - name: "identifier" in: "path" description: "Email (urlencoded) OR ID of the contact" required: true type: "string" x-exportParamName: "Identifier" - in: "body" name: "updateContact" description: "Values to update a contact" required: true schema: $ref: "#/definitions/updateContact" x-exportParamName: "UpdateContact" responses: "204": description: "Contact updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Contact's email not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Contacts" summary: "Delete a contact" operationId: "deleteContact" parameters: - name: "identifier" in: "path" description: "Email (urlencoded) OR ID of the contact" required: true type: "string" x-exportParamName: "Identifier" responses: "204": description: "Contact deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Contact not found" schema: $ref: "#/definitions/errorModel" "405": description: "You're not allowed to delete registered email contact with\ \ Brevo" schema: $ref: "#/definitions/errorModel" /contacts/batch: post: tags: - "Contacts" summary: "Update multiple contacts" operationId: "updateBatchContacts" parameters: - in: "body" name: "updateBatchContacts" description: "Values to update multiple contacts" required: true schema: $ref: "#/definitions/updateBatchContacts" x-exportParamName: "UpdateBatchContacts" responses: "204": description: "All contacts updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/{identifier}/campaignStats: get: tags: - "Contacts" summary: "Get email campaigns' statistics for a contact" operationId: "getContactStats" parameters: - name: "identifier" in: "path" description: "Email (urlencoded) OR ID of the contact" required: true type: "string" x-exportParamName: "Identifier" - name: "startDate" in: "query" 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" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" responses: "200": description: "Contact campaign statistics informations" examples: application/json: from: "sendermail@example.com" tags: - "tag1" - "tag2" messagesSent: - campaignId: 21 eventTime: "2016-05-03T20:15:13Z" - campaignId: 42 eventTime: "2016-10-17T10:30:01Z" - campaignId: 45 eventTime: "2016-11-09T11:45:02Z" opened: - campaignId: 21 count: 2 eventTime: "2016-05-03T21:24:56Z" ip: "66.249.93.118" - campaignId: 45 count: 1 eventTime: "2017-01-30T13:56:40Z" ip: "66.249.93.217" clicked: - campaignId: 21 links: - count: 2 eventTime: "2016-05-03T21:25:01Z" ip: "66.249.93.118" url: "https://url.domain.com/fbe5387ec717e333628380454f68670010b205ff/1/go?uid={EMAIL}&utm_source=brevo&utm_campaign=test_camp&utm_medium=email" delivered: - campaignId: 21 eventTime: "2016-05-03T20:15:13Z" schema: $ref: "#/definitions/getContactCampaignStats" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Contact's email not found" schema: $ref: "#/definitions/errorModel" /contacts/attributes: get: tags: - "Contacts" summary: "List all attributes" operationId: "getAttributes" parameters: [] responses: "200": description: "Attributes listed" examples: application/json: 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" schema: $ref: "#/definitions/getAttributes" /contacts/attributes/{attributeCategory}/{attributeName}: post: tags: - "Contacts" summary: "Create contact attribute" operationId: "createAttribute" parameters: - name: "attributeCategory" in: "path" description: "Category of the attribute" required: true type: "string" enum: - "normal" - "transactional" - "category" - "calculated" - "global" x-exportParamName: "AttributeCategory" - name: "attributeName" in: "path" description: "Name of the attribute" required: true type: "string" x-exportParamName: "AttributeName" - in: "body" name: "createAttribute" description: "Values to create an attribute" required: true schema: $ref: "#/definitions/createAttribute" x-exportParamName: "CreateAttribute" responses: "201": description: "Attribute created" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" put: tags: - "Contacts" summary: "Update contact attribute" operationId: "updateAttribute" parameters: - name: "attributeCategory" in: "path" description: "Category of the attribute" required: true type: "string" enum: - "category" - "calculated" - "global" x-exportParamName: "AttributeCategory" - name: "attributeName" in: "path" description: "Name of the existing attribute" required: true type: "string" x-exportParamName: "AttributeName" - in: "body" name: "updateAttribute" description: "Values to update an attribute" required: true schema: $ref: "#/definitions/updateAttribute" x-exportParamName: "UpdateAttribute" responses: "204": description: "Attribute updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Attribute not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Contacts" summary: "Delete an attribute" operationId: "deleteAttribute" parameters: - name: "attributeCategory" in: "path" description: "Category of the attribute" required: true type: "string" enum: - "normal" - "transactional" - "category" - "calculated" - "global" x-exportParamName: "AttributeCategory" - name: "attributeName" in: "path" description: "Name of the existing attribute" required: true type: "string" x-exportParamName: "AttributeName" responses: "204": description: "Attribute deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Attribute not found" schema: $ref: "#/definitions/errorModel" /contacts/folders: get: tags: - "Contacts" summary: "Get all folders" operationId: "getFolders" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: true type: "integer" default: 10 maximum: 50 minimum: 0 format: "int64" x-exportParamName: "Limit" - name: "offset" in: "query" description: "Index of the first document of the page" required: true type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Folders informations" examples: application/json: folders: - id: 42 name: "Ninja_Form" totalBlacklisted: 98 totalSubscribers: 4567 uniqueSubscribers: 4665 - id: 29 name: "Prestashop" totalBlacklisted: 10 totalSubscribers: 6543 uniqueSubscribers: 6553 count: 2 schema: $ref: "#/definitions/getFolders" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Contacts" summary: "Create a folder" operationId: "createFolder" parameters: - in: "body" name: "createFolder" description: "Name of the folder" required: true schema: $ref: "#/definitions/createUpdateFolder" x-exportParamName: "CreateFolder" responses: "201": description: "Folder created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/segments: get: tags: - "Contacts" summary: "Get all the Segments" operationId: "getSegments" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: true type: "integer" default: 10 maximum: 50 minimum: 0 format: "int64" x-exportParamName: "Limit" - name: "offset" in: "query" description: "Index of the first document of the page" required: true type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Folders informations" examples: application/json: segments: - id: 42 segmentName: "Segment1" categoryName: "Name1" updatedAt: "2017-03-12T12:30:00Z" - id: 29 segmentName: "Segment2" categoryName: "Name2" updatedAt: "2017-03-12T12:30:00Z" count: 2 schema: $ref: "#/definitions/getSegments" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/folders/{folderId}: get: tags: - "Contacts" summary: "Returns a folder's details" operationId: "getFolder" parameters: - name: "folderId" in: "path" description: "id of the folder" required: true type: "integer" format: "int64" x-exportParamName: "FolderId" responses: "200": description: "Folder details" examples: application/json: id: 1 name: "Client_Folder" totalBlacklisted: 987 totalSubscribers: 16778 uniqueSubscribers: 17765 schema: $ref: "#/definitions/getFolder" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Folder ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Contacts" summary: "Update a folder" operationId: "updateFolder" parameters: - name: "folderId" in: "path" description: "Id of the folder" required: true type: "integer" format: "int64" x-exportParamName: "FolderId" - in: "body" name: "updateFolder" description: "Name of the folder" required: true schema: $ref: "#/definitions/createUpdateFolder" x-exportParamName: "UpdateFolder" responses: "204": description: "Folder updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Folder ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Contacts" summary: "Delete a folder (and all its lists)" operationId: "deleteFolder" parameters: - name: "folderId" in: "path" description: "Id of the folder" required: true type: "integer" format: "int64" x-exportParamName: "FolderId" responses: "204": description: "Folder deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Folder ID not found" schema: $ref: "#/definitions/errorModel" /contacts/folders/{folderId}/lists: get: tags: - "Contacts" summary: "Get lists in a folder" operationId: "getFolderLists" parameters: - name: "folderId" in: "path" description: "Id of the folder" required: true type: "integer" format: "int64" x-exportParamName: "FolderId" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 10 maximum: 50 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Folder's Lists details" examples: application/json: 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: 8826 count: 3 schema: $ref: "#/definitions/getFolderLists" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Folder ID not found" schema: $ref: "#/definitions/errorModel" /contacts/lists: get: tags: - "Contacts" summary: "Get all the lists" operationId: "getLists" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 10 maximum: 50 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Lists informations" examples: application/json: 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 schema: $ref: "#/definitions/getLists" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Contacts" summary: "Create a list" operationId: "createList" parameters: - in: "body" name: "createList" description: "Values to create a list" required: true schema: $ref: "#/definitions/createList" x-exportParamName: "CreateList" responses: "201": description: "List created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/lists/{listId}: get: tags: - "Contacts" summary: "Get a list's details" operationId: "getList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" responses: "200": description: "List informations" examples: application/json: id: 12 name: "Newsletter_Weekly" totalSubscribers: 6533 totalBlacklisted: 63 uniqueSubscribers: 6596 folderId: 1 createdAt: "2016-02-26T11:56:08Z" 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 schema: $ref: "#/definitions/getExtendedList" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Contacts" summary: "Update a list" operationId: "updateList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" - in: "body" name: "updateList" description: "Values to update a list" required: true schema: $ref: "#/definitions/updateList" x-exportParamName: "UpdateList" responses: "204": description: "List updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Contacts" summary: "Delete a list" operationId: "deleteList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" responses: "204": description: "List deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" /contacts/lists/{listId}/contacts: get: tags: - "Contacts" summary: "Get contacts in a list" operationId: "getContactsFromList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" - name: "modifiedSince" in: "query" 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." required: false type: "string" x-exportParamName: "ModifiedSince" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 500 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Contact informations" examples: application/json: contacts: - email: "alex.pain@example.com" id: 45 emailBlacklisted: false smsBlacklisted: true createdAt: "2017-05-12T12:30:00Z" modifiedAt: "2017-05-12T12:30:00Z" listIds: - 12 - 9 - 20 listUnsubscribed: - 1 - 2 attributes: LASTNAME: "Pain" FIRSTNAME: "Alex" DOB: "2010-12-31" GENDER: "Kid" - email: "john.smith@example.com" id: 32 emailBlacklisted: true smsBlacklisted: false createdAt: "2017-05-12T12:30:00Z" modifiedAt: "2017-05-12T12:30:00Z" listIds: - 12 listUnsubscribed: - 1 attributes: LASTNAME: "Smith" FIRSTNAME: "John" DOB: "1986-06-21" GENDER: "Men" - email: "helen.rose@example.com" id: 65 emailBlacklisted: true smsBlacklisted: false createdAt: "2017-05-12T12:30:00Z" modifiedAt: "2017-05-12T12:30:00Z" listIds: - 12 - 9 - 20 listUnsubscribed: - 1 attributes: LASTNAME: "Rose" FIRSTNAME: "Helen" DOB: "1988-11-02" GENDER: "Women" SMS: "3375599887766" count: 17655 schema: $ref: "#/definitions/getContacts" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" /contacts/lists/{listId}/contacts/add: post: tags: - "Contacts" summary: "Add existing contacts to a list" operationId: "addContactToList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" - in: "body" name: "contactEmails" description: "Emails addresses OR IDs of the contacts" required: true schema: $ref: "#/definitions/addContactToList" x-exportParamName: "ContactEmails" responses: "201": description: "All contacts have been added successfully to the list with\ \ details of failed ones" schema: $ref: "#/definitions/postContactInfo" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" /contacts/lists/{listId}/contacts/remove: post: tags: - "Contacts" summary: "Delete a contact from a list" operationId: "removeContactFromList" parameters: - name: "listId" in: "path" description: "Id of the list" required: true type: "integer" format: "int64" x-exportParamName: "ListId" - in: "body" name: "contactEmails" description: "Emails addresses OR IDs of the contacts" required: true schema: $ref: "#/definitions/removeContactFromList" x-exportParamName: "ContactEmails" responses: "201": description: "All contacts have been removed successfully from the list\ \ with details of failed ones" schema: $ref: "#/definitions/postContactInfo" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "List ID not found" schema: $ref: "#/definitions/errorModel" /contacts/export: post: tags: - "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." operationId: "requestContactExport" parameters: - in: "body" name: "requestContactExport" description: "Values to request a contact export" required: true schema: $ref: "#/definitions/requestContactExport" x-exportParamName: "RequestContactExport" responses: "202": description: "Contact export request has been accepted" schema: $ref: "#/definitions/createdProcessId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /contacts/import: post: tags: - "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." operationId: "importContacts" parameters: - in: "body" name: "requestContactImport" description: "Values to import contacts in Brevo. To know more about the expected\ \ format, please have a look at ``https://help.brevo.com/hc/en-us/articles/209499265-Build-contacts-lists-for-your-email-marketing-campaigns``" required: true schema: $ref: "#/definitions/requestContactImport" x-exportParamName: "RequestContactImport" responses: "202": description: "Contact import request has been accepted" schema: $ref: "#/definitions/createdProcessId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smsCampaigns: get: tags: - "SMS Campaigns" summary: "Returns the information for all your created SMS campaigns" operationId: "getSmsCampaigns" parameters: - name: "status" in: "query" description: "Status of campaign." required: false type: "string" enum: - "suspended" - "archive" - "sent" - "queued" - "draft" - "inProcess" x-exportParamName: "Status" x-optionalDataType: "String" - name: "startDate" in: "query" 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' )" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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' )" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number limitation for the result returned" required: false type: "integer" default: 500 maximum: 1000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Beginning point in the list to retrieve from." required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "SMS campaigns informations" examples: application/json: campaigns: - id: 2 name: "PROMO CODE" status: "sent" content: "Visit our Store and get some discount !" scheduledAt: "2017-06-01T12:30:00Z" testSent: true sender: "MyCompany" createdAt: "2017-06-01T12:30:00Z" modifiedAt: "2017-05-01T12:30:00Z" sentDate: "2017-06-01T12:30:00Z" 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:00Z" testSent: false sender: "MyCompany" createdAt: "2017-06-01T12:30:00Z" modifiedAt: "2017-05-01T12:30:00Z" sentDate: "2017-06-01T12:30:00Z" recipients: lists: - 21 exclusionLists: - 13 statistics: delivered: 2987 sent: 3000 processing: 0 softBounces: 3 hardBounces: 1 unsubscriptions: 3 answered: 2 count: 12 schema: $ref: "#/definitions/getSmsCampaigns" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "SMS Campaigns" summary: "Creates an SMS campaign" operationId: "createSmsCampaign" parameters: - in: "body" name: "createSmsCampaign" description: "Values to create an SMS Campaign" required: true schema: $ref: "#/definitions/createSmsCampaign" x-exportParamName: "CreateSmsCampaign" responses: "201": description: "SMS campaign created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}: get: tags: - "SMS Campaigns" summary: "Get an SMS campaign" operationId: "getSmsCampaign" parameters: - name: "campaignId" in: "path" description: "id of the SMS campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "200": description: "SMS campaign informations" examples: application/json: id: 2 name: "PROMO CODE" status: "sent" content: "Visit our Store and get some discount !" scheduledAt: "2017-06-01T12:30:00Z" testSent: true sender: "MyCompany" createdAt: "2017-06-01T12:30:00Z" modifiedAt: "2017-05-01T12:30:00Z" recipients: lists: - 21 exclusionLists: - 13 statistics: delivered: 2987 sent: 3000 processing: 0 softBounces: 3 hardBounces: 1 unsubscriptions: 3 answered: 2 schema: $ref: "#/definitions/getSmsCampaign" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "SMS Campaigns" summary: "Update an SMS campaign" operationId: "updateSmsCampaign" parameters: - name: "campaignId" in: "path" description: "id of the SMS campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "updateSmsCampaign" description: "Values to update an SMS Campaign" required: true schema: $ref: "#/definitions/updateSmsCampaign" x-exportParamName: "UpdateSmsCampaign" responses: "204": description: "SMS campaign updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "SMS Campaigns" summary: "Delete an SMS campaign" operationId: "deleteSmsCampaign" parameters: - name: "campaignId" in: "path" description: "id of the SMS campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "204": description: "SMS campaign has been deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}/sendNow: post: tags: - "SMS Campaigns" summary: "Send your SMS campaign immediately" operationId: "sendSmsCampaignNow" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "204": description: "SMS campaign has been scheduled" "400": description: "SMS Campaign could not be sent" schema: $ref: "#/definitions/errorModel" "402": description: "You don't have enough credit to send your campaign. Please\ \ update your plan" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}/status: put: tags: - "SMS Campaigns" summary: "Update a campaign's status" operationId: "updateSmsCampaignStatus" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "status" description: "Status of the campaign." required: true schema: $ref: "#/definitions/updateCampaignStatus" x-exportParamName: "Status" responses: "204": description: "The campaign status has been updated successfully" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}/sendTest: post: tags: - "SMS Campaigns" summary: "Send a test SMS campaign" operationId: "sendTestSms" parameters: - name: "campaignId" in: "path" description: "Id of the SMS campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "phoneNumber" description: "Mobile number of the recipient with the country code. This number\ \ must belong to one of your contacts in Brevo account and must not be blacklisted" required: true schema: $ref: "#/definitions/sendTestSms" x-exportParamName: "PhoneNumber" responses: "204": description: "Test SMS has been sent successfully to the recipient" "400": description: "Test SMS could not be sent to the following email addresses" schema: $ref: "#/definitions/postSendSmsTestFailed" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}/exportRecipients: post: tags: - "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." operationId: "requestSmsRecipientExport" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "recipientExport" description: "Values to send for a recipient export request" required: false schema: $ref: "#/definitions/requestSmsRecipientExport" x-exportParamName: "RecipientExport" responses: "202": description: "Recipient export request has been accepted" schema: $ref: "#/definitions/createdProcessId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /smsCampaigns/{campaignId}/sendReport: post: tags: - "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." operationId: "sendSmsReport" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" - in: "body" name: "sendReport" description: "Values for send a report" required: true schema: $ref: "#/definitions/sendReport" x-exportParamName: "SendReport" responses: "204": description: "Report has been successfully sent to the defined recipients" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign ID not found" schema: $ref: "#/definitions/errorModel" /transactionalSMS/sms: post: tags: - "Transactional SMS" summary: "Send SMS message to a mobile number" operationId: "sendTransacSms" parameters: - in: "body" name: "sendTransacSms" description: "Values to send a transactional SMS" required: true schema: $ref: "#/definitions/sendTransacSms" x-exportParamName: "SendTransacSms" responses: "201": description: "SMS has been sent successfully to the recipient" schema: $ref: "#/definitions/sendSms" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "402": description: "You don't have enough credit to send your SMS. Please update\ \ your plan" schema: $ref: "#/definitions/errorModel" /transactionalSMS/statistics/aggregatedReport: get: tags: - "Transactional SMS" summary: "Get your SMS activity aggregated over a period of time" operationId: "getTransacAggregatedSmsReport" parameters: - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with startDate and endDate" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "tag" in: "query" description: "Filter on a tag" required: false type: "string" x-exportParamName: "Tag" x-optionalDataType: "String" responses: "200": description: "Aggregated SMS report informations" examples: application/json: 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 schema: $ref: "#/definitions/getTransacAggregatedSmsReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /transactionalSMS/statistics/reports: get: tags: - "Transactional SMS" summary: "Get your SMS activity aggregated per day" operationId: "getTransacSmsReport" parameters: - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with 'startDate' and 'endDate'" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "tag" in: "query" description: "Filter on a tag" required: false type: "string" x-exportParamName: "Tag" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Aggregated SMS report informations" examples: application/json: reports: - date: "2017-04-30" requests: 10756 delivered: 10103 hardBounces: 21 softBounces: 137 blocked: 1026 unsubscribed: 720 replied: 5091 accepted: 2318 rejected: 0 - date: "2017-05-01" requests: 18812 delivered: 17499 hardBounces: 34 softBounces: 254 blocked: 1514 unsubscribed: 1090 replied: 10089 accepted: 4393 rejected: 0 - date: "2017-05-02" requests: 14321 delivered: 13427 hardBounces: 16 softBounces: 176 blocked: 1646 unsubscribed: 1170 replied: 11563 accepted: 4689 rejected: 0 schema: $ref: "#/definitions/getTransacSmsReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /transactionalSMS/statistics/events: get: tags: - "Transactional SMS" summary: "Get all your SMS activity (unaggregated events)" operationId: "getSmsEvents" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 100 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date (YYYY-MM-DD) of\ \ the report" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ Not compatible with 'startDate' and 'endDate'" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "phoneNumber" in: "query" description: "Filter the report for a specific phone number" required: false type: "string" x-exportParamName: "PhoneNumber" x-optionalDataType: "String" - name: "event" in: "query" description: "Filter the report for specific events" required: false type: "string" enum: - "bounces" - "hardBounces" - "softBounces" - "delivered" - "sent" - "accepted" - "unsubscription" - "replies" - "blocked" - "rejected" x-exportParamName: "Event" x-optionalDataType: "String" - name: "tags" in: "query" description: "Filter the report for specific tags passed as a serialized urlencoded\ \ array" required: false type: "string" x-exportParamName: "Tags" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Sms events report informations" examples: application/json: events: - phoneNumber: "00911059469013" date: "2015-05-20T12:30:00Z" messageId: "1473139351170140" event: "sent" reason: "Recipient is currently unreachable" tag: "cabWaiting" - phoneNumber: "00911059469013" date: "2015-05-20T16:30:00Z" messageId: "1473139351170140" event: "delivered" reason: "Recipient is currently unreachable" tag: "cabRequest" schema: $ref: "#/definitions/getSmsEventReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsappCampaigns/{campaignId}: get: tags: - "WhatsApp Campaigns" summary: "Get a WhatsApp campaign" operationId: "getWhatsAppCampaign" parameters: - name: "campaignId" in: "path" description: "Id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "200": description: "Get WhatsApp campaign information on the basis of campaignId" examples: application/json: response: value: id: 1672035851100690 campaignName: "Test WhatsApp Campaign" campaignStatus: "sent" scheduledAt: "2022-12-26T09:50:00.000+0000" senderNumber: 9368207029 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.brevo" - 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.000+0000" modifiedAt: "2022-12-26T08:50:00.000+0000" schema: $ref: "#/definitions/getWhatsappCampaignOverview" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign Id not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "WhatsApp Campaigns" summary: "Delete a WhatsApp campaign" operationId: "deleteWhatsAppCampaign" parameters: - name: "campaignId" in: "path" description: "id of the campaign" required: true type: "integer" format: "int64" x-exportParamName: "CampaignId" responses: "204": description: "WhatsApp campaign has been deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Campaign Id not found" schema: $ref: "#/definitions/errorModel" /whatsappCampaigns/template-list: get: tags: - "WhatsApp Campaigns" summary: "Return all your created WhatsApp templates" operationId: "getWhatsAppTemplates" parameters: - name: "startDate" in: "query" description: "**Mandatory if endDate is used**. Starting (urlencoded) UTC\ \ date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created.\n\ **Prefer to pass your timezone in date-time format for accurate result**\ \ \n" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "**Mandatory if startDate is used**. Ending (urlencoded) UTC\ \ date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the templates created.\n\ **Prefer to pass your timezone in date-time format for accurate result**\ \ \n" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 100 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ modification. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "WhatsApp templates informations" examples: application/json: response: value: count: 2 templates: - id: 235 name: "campaign_22" type: "whatsapp" status: "approved" language: "en" category: "MARKETING" errorReason: "NONE" createdAt: "2017-05-01T12:30:00.000+0000" modifiedAt: "2017-05-01T12:30:00.000+0000" - id: 124 name: "test-template" type: "whatsapp" status: "draft" language: "" category: "MARKETING" errorReason: "NONE" createdAt: "2017-0" modifiedAt: "2017-05-01T12:30:00.000+0000" schema: $ref: "#/definitions/getWATemplates" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsappCampaigns: get: tags: - "WhatsApp Campaigns" summary: "Return all your created WhatsApp campaigns" operationId: "getWhatsAppCampaigns" parameters: - name: "startDate" in: "query" description: "**Mandatory if endDate is used**. Starting (urlencoded) UTC\ \ date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created.\n\ **Prefer to pass your timezone in date-time format for accurate result**\n" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "**Mandatory if startDate is used**. Ending (urlencoded) UTC\ \ date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) to filter the campaigns created.\n\ **Prefer to pass your timezone in date-time format for accurate result**\n" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 100 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ modification. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "WhatsApp campaigns informations" examples: application/json: count: 23 campaigns: - id: 1672035851100690 campaignName: "campaign_22" campaignStatus: "sent" templateId: 637660278078655 scheduledAt: "2022-12-27T09:50:00.000+0000" errorReason: "NONE" name: "campaign_22" type: "whatsapp" status: "approved" language: "en" category: "MARKETING" invalidatedContacts: 0 stats: sent: 3 delivered: 3 read: 2 unsubscribe: 0 notSent: 4 readPercentage: 28.57 createdAt: "2017-05-01T12:30:00.000+0000" modifiedAt: "2017-05-01T12:30:00.000+0000" schema: $ref: "#/definitions/getWhatsappCampaigns" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "WhatsApp Campaigns" summary: "Create and Send a WhatsApp campaign" operationId: "createWhatsAppCampaign" parameters: - in: "body" name: "whatsAppCampaigns" description: "Values to create a campaign" required: true schema: $ref: "#/definitions/createWhatsAppCampaign" x-exportParamName: "WhatsAppCampaigns" responses: "201": description: "WhatsApp campaign created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsppCampaigns/template: post: tags: - "WhatsApp Campaigns" summary: "Create a WhatsApp template" operationId: "createWhatsAppTemplate" parameters: - in: "body" name: "whatsAppTemplates" description: "Values to create a template" required: true schema: $ref: "#/definitions/createWhatsAppTemplate" x-exportParamName: "WhatsAppTemplates" responses: "201": description: "WhatsApp campaign created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsappCampaigns/config: get: tags: - "WhatsApp Campaigns" summary: "Get your WhatsApp API account information" operationId: "getWhatsAppConfig" parameters: [] responses: "200": description: "Get all the information of your WhatsApp API account" examples: application/json: whatsappBusinessAccountID: 105569359072383 sendingLimit: "TIER_1K" phoneNumberQuality: "GREEN" whatsappBusinessAccountStatus: "APPROVED" businessStatus: "verified" phoneNumberNameStatus: "APPROVED" schema: $ref: "#/definitions/getWhatsAppConfig" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /senders: get: tags: - "Senders" summary: "Get the list of all your senders" operationId: "getSenders" parameters: - name: "ip" in: "query" description: "Filter your senders for a specific ip (available for dedicated\ \ IP usage only)" required: false type: "string" x-exportParamName: "Ip" x-optionalDataType: "String" - name: "domain" in: "query" description: "Filter your senders for a specific domain" required: false type: "string" x-exportParamName: "Domain" x-optionalDataType: "String" responses: "200": description: "list of senders" examples: application/json: 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 schema: $ref: "#/definitions/getSendersList" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Senders" summary: "Create a new sender" operationId: "createSender" parameters: - in: "body" name: "sender" description: "sender's name" required: false schema: $ref: "#/definitions/createSender" x-exportParamName: "Sender" responses: "201": description: "sender created" schema: $ref: "#/definitions/createSenderModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /senders/{senderId}: put: tags: - "Senders" summary: "Update a sender" operationId: "updateSender" parameters: - name: "senderId" in: "path" description: "Id of the sender" required: true type: "integer" format: "int64" x-exportParamName: "SenderId" - in: "body" name: "sender" description: "sender's name" required: false schema: $ref: "#/definitions/updateSender" x-exportParamName: "Sender" responses: "204": description: "sender updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Sender ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Senders" summary: "Delete a sender" operationId: "deleteSender" parameters: - name: "senderId" in: "path" description: "Id of the sender" required: true type: "integer" format: "int64" x-exportParamName: "SenderId" responses: "204": description: "sender deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Sender ID not found" schema: $ref: "#/definitions/errorModel" /senders/{senderId}/validate: put: tags: - "Senders" summary: "Update a sender" operationId: "validateSenderByOTP" parameters: - name: "senderId" in: "path" description: "Id of the sender" required: true type: "integer" format: "int64" x-exportParamName: "SenderId" - in: "body" name: "otp" description: "otp" required: false schema: $ref: "#/definitions/otp" x-exportParamName: "Otp" responses: "204": description: "sender updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Sender ID not found" schema: $ref: "#/definitions/errorModel" /senders/{senderId}/ips: get: tags: - "Senders" summary: "Get all the dedicated IPs for a sender" operationId: "getIpsFromSender" parameters: - name: "senderId" in: "path" description: "Id of the sender" required: true type: "integer" format: "int64" x-exportParamName: "SenderId" responses: "200": description: "list of dedicated IPs" examples: application/json: 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 schema: $ref: "#/definitions/getIpsFromSender" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Sender ID not found" schema: $ref: "#/definitions/errorModel" /senders/ips: get: tags: - "Senders" summary: "Get all the dedicated IPs for your account" operationId: "getIps" parameters: [] responses: "200": description: "list of dedicated IPs" examples: application/json: 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" schema: $ref: "#/definitions/getIps" /senders/domains: get: tags: - "Domains" summary: "Get the list of all your domains" operationId: "getDomains" parameters: [] responses: "200": description: "list of domains" examples: application/json: domains: - id: 1 domain_name: "mycompany.com" authenticated: true verified: true ip: "123.98.689.7" - id: 2 domain_name: "myexample.com" authenticated: false verified: true schema: $ref: "#/definitions/getDomainsList" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Domains" summary: "Create a new domain" operationId: "createDomain" parameters: - in: "body" name: "domainName" description: "domain's name" required: false schema: $ref: "#/definitions/createDomain" x-exportParamName: "DomainName" responses: "200": description: "domain created" schema: $ref: "#/definitions/createDomainModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /senders/domains/{domainName}: get: tags: - "Domains" summary: "Validate domain configuration" operationId: "getDomainonfiguration" parameters: - name: "domainName" in: "path" description: "Domain name" required: true type: "string" x-exportParamName: "DomainName" responses: "200": description: "domain configuration" schema: $ref: "#/definitions/getDomainonfigurationModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Domain does not exist" schema: $ref: "#/definitions/errorModel" delete: tags: - "Domains" summary: "Delete a domain" operationId: "deleteDomain" parameters: - name: "domainName" in: "path" description: "Domain name" required: true type: "string" x-exportParamName: "DomainName" responses: "200": description: "domain deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Domain does not exist" schema: $ref: "#/definitions/errorModel" /senders/domains/{domainName}/authenticate: put: tags: - "Domains" summary: "Authenticate a domain" operationId: "authenticateDomain" parameters: - name: "domainName" in: "path" description: "Domain name" required: true type: "string" x-exportParamName: "DomainName" responses: "200": description: "domain authenticated" schema: $ref: "#/definitions/authenticateDomainModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Domain does not exist" schema: $ref: "#/definitions/errorModel" /webhooks: get: tags: - "Webhooks" summary: "Get all webhooks" operationId: "getWebhooks" parameters: - name: "type" in: "query" description: "Filter on webhook type" required: false type: "string" default: "transactional" enum: - "marketing" - "transactional" - "inbound" x-exportParamName: "Type_" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of webhook\ \ creation" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Webhooks informations" examples: application/json: 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:09Z" modifiedAt: "2016-07-18T16:00:50Z" - url: "http://exmaple.domain.com/15kxxxxxn1" id: 22770 description: "Webhook triggered on campaign hard bounces" events: - "hardBounces" type: "marketing" createdAt: "2017-02-20T14:30:00Z" modifiedAt: "2017-02-20T19:00:00Z" schema: $ref: "#/definitions/getWebhooks" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Webhooks" summary: "Create a webhook" operationId: "createWebhook" parameters: - in: "body" name: "createWebhook" description: "Values to create a webhook" required: true schema: $ref: "#/definitions/createWebhook" x-exportParamName: "CreateWebhook" responses: "201": description: "Webhook created" schema: $ref: "#/definitions/createModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /webhooks/{webhookId}: get: tags: - "Webhooks" summary: "Get a webhook details" operationId: "getWebhook" parameters: - name: "webhookId" in: "path" description: "Id of the webhook" required: true type: "integer" format: "int64" x-exportParamName: "WebhookId" responses: "200": description: "Webhook informations" examples: application/json: 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:10Z" modifiedAt: "2016-06-08T11:30:00Z" schema: $ref: "#/definitions/getWebhook" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Webhook ID not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Webhooks" summary: "Update a webhook" operationId: "updateWebhook" parameters: - name: "webhookId" in: "path" description: "Id of the webhook" required: true type: "integer" format: "int64" x-exportParamName: "WebhookId" - in: "body" name: "updateWebhook" description: "Values to update a webhook" required: true schema: $ref: "#/definitions/updateWebhook" x-exportParamName: "UpdateWebhook" responses: "204": description: "Webhook updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Webhook ID not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Webhooks" summary: "Delete a webhook" operationId: "deleteWebhook" parameters: - name: "webhookId" in: "path" description: "Id of the webhook" required: true type: "integer" format: "int64" x-exportParamName: "WebhookId" responses: "204": description: "Webhook deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Webhook ID not found" schema: $ref: "#/definitions/errorModel" /webhooks/export: post: tags: - "Webhooks" summary: "Export all transactional events" description: "This endpoint will submit a request to get the history of webhooks\ \ in the CSV file. The link to download that CSV file will send to the webhook\ \ link provided in notifyURL of the body payload." operationId: "exportWebhooksHistory" parameters: - in: "body" name: "Export webhook history" description: "Values to submit for webhooks history" required: true schema: $ref: "#/definitions/exportWebhooksHistory" x-exportParamName: "ExportWebhookHistory" responses: "202": description: "Request accepted" schema: $ref: "#/definitions/createdProcessId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /reseller/children: get: tags: - "Reseller" summary: "Get the list of all children accounts" operationId: "getResellerChilds" parameters: - name: "limit" in: "query" description: "Number of documents for child accounts information per page" required: false type: "integer" default: 10 maximum: 20 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" responses: "200": description: "list of children" examples: application/json: 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 schema: $ref: "#/definitions/getChildrenList" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" post: tags: - "Reseller" summary: "Creates a reseller child" operationId: "createResellerChild" parameters: - in: "body" name: "resellerChild" description: "reseller child to add" required: false schema: $ref: "#/definitions/createChild" x-exportParamName: "ResellerChild" responses: "201": description: "child created" schema: $ref: "#/definitions/createReseller" "400": description: "Bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}: get: tags: - "Reseller" summary: "Get a child account's details" operationId: "getChildInfo" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" responses: "200": description: "Information for the child" examples: application/json: 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" schema: $ref: "#/definitions/getChildInfo" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Reseller" summary: "Update info of reseller's child based on the child identifier supplied" operationId: "updateResellerChild" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "resellerChild" description: "values to update in child profile" required: true schema: $ref: "#/definitions/updateChild" x-exportParamName: "ResellerChild" responses: "204": description: "reseller's child updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Reseller" summary: "Delete a single reseller child based on the child identifier supplied" operationId: "deleteResellerChild" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or child id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" responses: "204": description: "child deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/accountStatus: put: tags: - "Reseller" summary: "Update info of reseller's child account status based on the childIdentifier\ \ supplied" operationId: "updateChildAccountStatus" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "updateChildAccountStatus" description: "values to update in child account status" required: true schema: $ref: "#/definitions/updateChildAccountStatus" x-exportParamName: "UpdateChildAccountStatus" responses: "204": description: "reseller's child account status updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/accountCreationStatus: get: tags: - "Reseller" summary: "Get the status of a reseller's child account creation, whether it\ \ is successfully created (exists) or not based on the identifier supplied" operationId: "getChildAccountCreationStatus" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" responses: "200": description: "status of reseller's child account" examples: application/json: childAccountCreated: true schema: $ref: "#/definitions/getChildAccountCreationStatus" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/ips/associate: post: tags: - "Reseller" summary: "Associate a dedicated IP to the child" operationId: "associateIpToChild" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "ip" description: "IP to associate" required: true schema: $ref: "#/definitions/manageIp" x-exportParamName: "Ip" responses: "204": description: "Dedicated IP is associated to the child" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/ips/dissociate: post: tags: - "Reseller" summary: "Dissociate a dedicated IP to the child" operationId: "dissociateIpFromChild" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "ip" description: "IP to dissociate" required: true schema: $ref: "#/definitions/manageIp" x-exportParamName: "Ip" responses: "204": description: "Dedicated IP is dissociated from the child" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/credits/add: post: tags: - "Reseller" summary: "Add Email and/or SMS credits to a specific child account" operationId: "addCredits" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "addCredits" description: "Values to post to add credit to a specific child account" required: true schema: $ref: "#/definitions/addCredits" x-exportParamName: "AddCredits" responses: "200": description: "Credits added" examples: application/json: child: sms: 500 email: 2000 reseller: sms: 12900 email: 2000000 schema: $ref: "#/definitions/remainingCreditModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/credits/remove: post: tags: - "Reseller" summary: "Remove Email and/or SMS credits from a specific child account" operationId: "removeCredits" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "removeCredits" description: "Values to post to remove email or SMS credits from a specific\ \ child account" required: true schema: $ref: "#/definitions/removeCredits" x-exportParamName: "RemoveCredits" responses: "200": description: "Credits removed" examples: application/json: child: sms: 500 email: 2000 reseller: sms: 12900 email: 2000000 schema: $ref: "#/definitions/remainingCreditModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/domains: get: tags: - "Reseller" summary: "Get all sender domains for a specific child account" operationId: "getChildDomains" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" responses: "200": description: "Sender domains of the child" examples: application/json: - domain: "mycustomdomain.com" active: true - domain: "mynewdomain.com" active: true schema: $ref: "#/definitions/getChildDomains" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" post: tags: - "Reseller" summary: "Create a domain for a child account" operationId: "createChildDomain" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - in: "body" name: "addChildDomain" description: "Sender domain to add for a specific child account. This will\ \ not be displayed to the parent account." required: true schema: $ref: "#/definitions/addChildDomain" x-exportParamName: "AddChildDomain" responses: "201": description: "Domain added" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/domains/{domainName}: put: tags: - "Reseller" summary: "Update the sender domain of reseller's child based on the childIdentifier\ \ and domainName passed" operationId: "updateChildDomain" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - name: "domainName" in: "path" description: "Pass the existing domain that needs to be updated" required: true type: "string" x-exportParamName: "DomainName" - in: "body" name: "updateChildDomain" description: "value to update for sender domain" required: true schema: $ref: "#/definitions/updateChildDomain" x-exportParamName: "UpdateChildDomain" responses: "204": description: "reseller's child domain updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Reseller" summary: "Delete the sender domain of the reseller child based on the childIdentifier\ \ and domainName passed" operationId: "deleteChildDomain" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" - name: "domainName" in: "path" description: "Pass the existing domain that needs to be deleted" required: true type: "string" x-exportParamName: "DomainName" responses: "204": description: "child domain deleted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /reseller/children/{childIdentifier}/auth: get: tags: - "Reseller" summary: "Get session token to access Brevo (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]" operationId: "getSsoToken" parameters: - name: "childIdentifier" in: "path" description: "Either auth key or id of reseller's child" required: true type: "string" x-exportParamName: "ChildIdentifier" responses: "200": description: "Session token" examples: application/json: token: "5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0" schema: $ref: "#/definitions/getSsoToken" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a reseller" schema: $ref: "#/definitions/errorModel" "404": description: "Child auth key or child id not found" schema: $ref: "#/definitions/errorModel" /account: get: tags: - "Account" summary: "Get your account information, plan and credits details" operationId: "getAccount" parameters: [] responses: "200": description: "account informations" examples: application/json: plan: - type: "payAsYouGo" credits: 5000 creditsType: "sendLimit" - type: "subscription" credits: 39983 creditsType: "sendLimit" startDate: "2017-03-11" endDate: "2017-04-11" - 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" schema: $ref: "#/definitions/getAccount" /organization/activities: get: tags: - "Account" summary: "Get user activity logs" operationId: "getAccountActivity" parameters: - name: "startDate" in: "query" description: "Mandatory if endDate is used. Enter start date in UTC date (YYYY-MM-DD)\ \ format to filter the activity in your account. Maximum time period that\ \ can be selected is one month. Additionally, you can retrieve activity\ \ logs from the past 12 months from the date of your search." required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Enter end date in UTC date (YYYY-MM-DD)\ \ format to filter the activity in your account. Maximum time period that\ \ can be selected is one month." required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 10 maximum: 100 minimum: 1 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page." required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" responses: "200": description: "list of user activity logs" examples: application/json: logs: - action: "login-success" date: "2023-03-16T16:49:23+05:30" user_email: "test@mycompany.com" user_ip: "192.158.1.34" user_agent: "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us)" - action: "update-profile" date: "2023-03-17T16:49:23+05:30" user_email: "test@myexample.com" user_ip: "192.158.1.38" user_agent: "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us)" count: 2 schema: $ref: "#/definitions/getAccountActivity" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /processes: get: tags: - "Process" summary: "Return all the processes for your account" operationId: "getProcesses" parameters: - name: "limit" in: "query" description: "Number limitation for the result returned" required: false type: "integer" default: 10 maximum: 50 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Beginning point in the list to retrieve from." required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "processes informations" examples: application/json: 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: "filename.csv" count: 3 schema: $ref: "#/definitions/getProcesses" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /processes/{processId}: get: tags: - "Process" summary: "Return the informations for a process" operationId: "getProcess" parameters: - name: "processId" in: "path" description: "Id of the process" required: true type: "integer" format: "int64" x-exportParamName: "ProcessId" responses: "200": description: "process informations" examples: application/json: id: 194 status: "completed" name: "SEARCH_EXPORT_USERS" export_url: "filename.csv" schema: $ref: "#/definitions/getProcess" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Process ID not found" examples: application/json: code: "invalid_parameter" message: "processId is invalid" schema: $ref: "#/definitions/errorModel" /inbound/events: get: tags: - "Inbound 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." operationId: "getInboundEmailEvents" parameters: - name: "sender" in: "query" description: "Email address of the sender." required: false type: "string" x-exportParamName: "Sender" x-optionalDataType: "String" - name: "startDate" in: "query" description: "Mandatory if endDate is used. Starting date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ)\ \ from which you want to fetch the list. Maximum time period that can be\ \ selected is one month." required: false type: "string" format: "datetime" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "Mandatory if startDate is used. Ending date (YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss.SSSZ)\ \ till which you want to fetch the list. Maximum time period that can be\ \ selected is one month." required: false type: "string" format: "datetime" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents returned per page" required: false type: "integer" default: 100 maximum: 500 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document on the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "List of events for received emails." examples: application/json: 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" schema: $ref: "#/definitions/getInboundEmailEvents" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /inbound/events/{uuid}: get: tags: - "Inbound 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." operationId: "getInboundEmailEventsByUuid" parameters: - name: "uuid" in: "path" description: "UUID to fetch events specific to recieved email" required: true type: "string" x-exportParamName: "Uuid" responses: "200": description: "List of events for a particular received email on the basis\ \ of uuid." examples: application/json: receivedAt: "2017-03-12T12:30:00.000Z" deliveredAt: "2017-03-12T12:31:00.000Z" sender: "alice@example.com" recipient: "bob@example.com" messageId: "" subject: "Re: Question about your API" attachments: - name: "invoice.pdf" contentType: "application/pdf" 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" schema: $ref: "#/definitions/getInboundEmailEventsByUuid" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /inbound/attachments/{downloadToken}: get: tags: - "Inbound Parsing" summary: "Retrieve inbound attachment with download token." description: "This endpoint will retrieve inbound attachment with download token." operationId: "getInboundEmailAttachment" parameters: - name: "downloadToken" in: "path" description: "Token to fetch a particular attachment" required: true type: "string" x-exportParamName: "DownloadToken" responses: "200": description: "Attachment information" headers: Content-Type: type: "string" description: "example: image/png" Content-Disposition: type: "string" description: "example: attachment; filename=\"download.png\"" Content-Length: type: "integer" description: "example: 4032" schema: type: "file" format: "binary" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "attachment not found" schema: $ref: "#/definitions/errorModel" /corporate/subAccount: get: tags: - "Master account" 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: "offset" in: "query" description: "Index of the first sub-account in the page" required: true type: "integer" x-exportParamName: "Offset" - name: "limit" in: "query" description: "Number of sub-accounts to be displayed on each page" required: true type: "integer" x-exportParamName: "Limit" responses: "200": description: "Sub-accounts list" examples: application/json: count: 3 subAccounts: - id: 4043629 companyName: "Company1" active: true createdAt: 1629439311 - id: 3984002 companyName: "Company2" active: true createdAt: 1629439311 - id: 3524191 companyName: "Company3" active: true createdAt: 1614713641 schema: $ref: "#/definitions/subAccountsResponse" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Master account" summary: "Create a new sub-account under a master account." description: "This endpoint will create a new sub-account under a master account" parameters: - in: "body" name: "subAccountCreate" description: "values to create new sub-account" required: true schema: $ref: "#/definitions/createSubAccount" x-exportParamName: "SubAccountCreate" responses: "201": description: "Created sub-account ID" examples: application/json: id: 8767868 schema: $ref: "#/definitions/createSubAccountResponse" "400": description: "Bad request" examples: application/json: code: "missing_parameter" message: "Missing companyName attribute in the request" schema: $ref: "#/definitions/errorModel" /corporate/subAccount/{id}: get: tags: - "Master account" summary: "Get sub-account details" description: "This endpoint will provide the details for the specified sub-account\ \ company" parameters: - name: "id" in: "path" description: "Id of the sub-account organization" required: true type: "integer" format: "int64" x-exportParamName: "Id" responses: "200": description: "Sub-account organization details" examples: application/json: name: "Uday Pandit" email: "uday+1@brevo.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" schema: $ref: "#/definitions/subAccountDetailsResponse" delete: tags: - "Master account" summary: "Delete a sub-account" parameters: - name: "id" in: "path" description: "Id of the sub-account organization to be deleted" required: true type: "integer" format: "int64" x-exportParamName: "Id" responses: "204": description: "Returned when sub-account is deleted succesfully" "400": description: "bad request" examples: application/json: message: "Sub-account 2039dfsddf885 is not valid" code: "missing_parameter" "404": description: "Organization not found" examples: application/json: message: "Sub-account 2039885 was not found" code: "document_not_found" /corporate/subAccount/{id}/plan: put: tags: - "Master account" summary: "Update sub-account plan" description: "This endpoint will update the sub-account plan" parameters: - name: "id" in: "path" description: "Id of the sub-account organization" required: true type: "integer" format: "int64" x-exportParamName: "Id" - in: "body" name: "updatePlanDetails" description: "Values to update a sub-account plan" required: true schema: $ref: "#/definitions/subAccountUpdatePlanRequest" x-exportParamName: "UpdatePlanDetails" responses: "204": description: "Sub account plan updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a master account" examples: application/json: code: "permission_denied" message: "Access forbidden." schema: $ref: "#/definitions/errorModel" /corporate/subAccount/ssoToken: post: tags: - "Master account" summary: "Generate SSO token to access Brevo" description: "This endpoint generates an sso token to authenticate and access\ \ a sub-account of the master using the account endpoint https://account-app.brevo.com/account/login/sub-account/sso/[token],\ \ where [token] will be replaced by the actual token." parameters: - in: "body" name: "ssoTokenRequest" description: "Values to generate SSO token for sub-account" required: true schema: $ref: "#/definitions/ssoTokenRequest" x-exportParamName: "SsoTokenRequest" responses: "200": description: "Session token" examples: application/json: token: "5cadaxxxxxxxxxxxxxxxxxxxx5a179f85a0" schema: $ref: "#/definitions/getSsoToken" "400": description: "bad request" examples: application/json: code: "invalid_parameter" message: "Invalid sub-account id." schema: $ref: "#/definitions/errorModel" "403": description: "Current account is not a master account" examples: application/json: code: "permission_denied" message: "Access forbidden." schema: $ref: "#/definitions/errorModel" /corporate/masterAccount: get: tags: - "Master account" summary: "Get the details of requested master account" description: "This endpoint will provide the details of the master account." parameters: [] responses: "200": description: "Master account details" examples: application/json: 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 schema: $ref: "#/definitions/masterDetailsResponse" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /corporate/subAccount/key: post: tags: - "Master account" summary: "Create an API key for a sub-account" description: "This endpoint will generate an API v3 key for a sub account" parameters: - in: "body" name: "createApiKeyRequest" description: "Values to generate API key for sub-account" required: true schema: $ref: "#/definitions/createApiKeyRequest" x-exportParamName: "CreateApiKeyRequest" responses: "201": description: "API Key" examples: application/json: status: "success" key: "xkeysib-21881axxxxxcc92e04-mIrexxxx7z" schema: $ref: "#/definitions/createApiKeyResponse" "400": description: "bad request" examples: application/json: code: "invalid_parameter" message: "id should be a positive number" schema: $ref: "#/definitions/errorModel" /companies: get: tags: - "Companies" summary: "Get all companies" parameters: - name: "filters" in: "query" description: "Filter by attrbutes. If you have filter for owner on your side\ \ please send it as {\"attributes.owner\":\"5b1a17d914b73d35a76ca0c7\"}" required: false type: "string" x-exportParamName: "Filters" x-optionalDataType: "String" - name: "linkedContactsIds" in: "query" description: "Filter by linked contacts ids" required: false type: "integer" format: "int64" x-exportParamName: "LinkedContactsIds" x-optionalDataType: "Int64" - name: "linkedDealsIds" in: "query" description: "Filter by linked deals ids" required: false type: "string" format: "objectID" x-exportParamName: "LinkedDealsIds" x-optionalDataType: "String" - name: "page" in: "query" description: "Index of the first document of the page" required: false type: "integer" format: "int64" x-exportParamName: "Page" x-optionalDataType: "Int64" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order. Default\ \ order is **descending** by creation if `sort` is not passed" required: false type: "string" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "sortBy" in: "query" description: "The field used to sort field names." required: false type: "string" x-exportParamName: "SortBy" x-optionalDataType: "String" responses: "200": description: "Returns companies list with filters" schema: $ref: "#/definitions/CompaniesList" "400": description: "Returned when query params are invalid" examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" post: tags: - "Companies" summary: "Create a company" parameters: - in: "body" name: "body" description: "Company create data." required: true schema: $ref: "#/definitions/body" x-exportParamName: "Body" responses: "200": description: "Created new company" schema: $ref: "#/definitions/inline_response_200" "400": description: "Returned when invalid data posted" /companies/{id}: get: tags: - "Companies" summary: "Get a company" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returns the company by id" schema: $ref: "#/definitions/Company" "400": description: "Returned when company id is invalid" examples: application/json: message: "Route company id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Companies" summary: "Delete a company" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "Returned when item deleted" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route company id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when company id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" patch: tags: - "Companies" summary: "Update a company" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Updated company details." required: true schema: $ref: "#/definitions/body_1" x-exportParamName: "Body" responses: "200": description: "Company updated successfully" schema: $ref: "#/definitions/Company" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route company id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when company id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" /companies/attributes: get: tags: - "Companies" summary: "Get company attributes" parameters: [] responses: "200": description: "Returns list of company attributes" schema: $ref: "#/definitions/CompanyAttributes" /companies/link-unlink/{id}: patch: tags: - "Companies" summary: "Link and Unlink company with contacts and deals" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Linked / Unlinked contacts and deals ids." required: true schema: $ref: "#/definitions/body_2" x-exportParamName: "Body" responses: "204": description: "Returns list of company attributes" "400": description: "Returned when query params are invalid" examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" /crm/pipeline/details: get: tags: - "Deals" summary: "Get pipeline stages" parameters: [] responses: "200": description: "Returns list of pipeline stages" schema: $ref: "#/definitions/Pipeline" /crm/attributes/deals: get: tags: - "Deals" summary: "Get deal attributes" parameters: [] responses: "200": description: "Returns list of deal attributes" schema: $ref: "#/definitions/DealAttributes" /crm/deals: get: tags: - "Deals" summary: "Get all deals" parameters: - name: "filters[attributes]" in: "query" description: "Filter by attrbutes. If you have filter for owner on your side\ \ please send it as `attributes.owner`.\"" required: false type: "string" x-exportParamName: "FiltersAttributes" x-optionalDataType: "String" - name: "filters[linkedCompaniesIds]" in: "query" description: "Filter by linked companies ids" required: false type: "string" x-exportParamName: "FiltersLinkedCompaniesIds" x-optionalDataType: "String" - name: "filters[linkedContactsIds]" in: "query" description: "Filter by linked companies ids" required: false type: "string" x-exportParamName: "FiltersLinkedContactsIds" x-optionalDataType: "String" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order. Default\ \ order is **descending** by creation if `sort` is not passed" required: false type: "string" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "sortBy" in: "query" description: "The field used to sort field names." required: false type: "string" x-exportParamName: "SortBy" x-optionalDataType: "String" responses: "200": description: "Returns deals list with filters" schema: $ref: "#/definitions/DealsList" "400": description: "Returned when query params are invalid" examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" post: tags: - "Deals" summary: "Create a deal" parameters: - in: "body" name: "body" description: "Deal create data." required: true schema: $ref: "#/definitions/body_3" x-exportParamName: "Body" responses: "201": description: "Created new Deal" schema: $ref: "#/definitions/inline_response_201" "400": description: "Returned when invalid data posted" /crm/deals/{id}: get: tags: - "Deals" summary: "Get a deal" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returns the deal by id" schema: $ref: "#/definitions/Deal" "400": description: "Returned when task id is invalid" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Deals" summary: "Delete a deal" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "Returned when item deleted" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when deal id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" patch: tags: - "Deals" summary: "Update a deal" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Updated deal details." required: true schema: $ref: "#/definitions/body_4" x-exportParamName: "Body" responses: "204": description: "Deal updated successfully" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when deal id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" /crm/deals/link-unlink/{id}: patch: tags: - "Deals" summary: "Link and Unlink a deal with contacts and companies" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Linked / Unlinked contacts and companies ids." required: true schema: $ref: "#/definitions/body_5" x-exportParamName: "Body" responses: "204": description: "Successfully linked/unlinked contacts/companies with the deal." "400": description: "Returned when query params are invalid or invalid data provided\ \ in request." examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" /crm/tasktypes: get: tags: - "Tasks" summary: "Get all task types" parameters: [] responses: "200": description: "Returns all the Task types" schema: $ref: "#/definitions/TaskTypes" /crm/tasks: get: tags: - "Tasks" summary: "Get all tasks" parameters: - name: "filter[type]" in: "query" description: "Filter by task type (ID)" required: false type: "string" x-exportParamName: "FilterType" x-optionalDataType: "String" - name: "filter[status]" in: "query" description: "Filter by task status" required: false type: "string" enum: - "done" - "undone" x-exportParamName: "FilterStatus" x-optionalDataType: "String" - name: "filter[date]" in: "query" description: "Filter by date" required: false type: "string" enum: - "overdue" - "today" - "tomorrow" - "week" - "range" x-exportParamName: "FilterDate" x-optionalDataType: "String" - name: "filter[assignTo]" in: "query" description: "Filter by assignTo id" required: false type: "string" x-exportParamName: "FilterAssignTo" x-optionalDataType: "String" - name: "filter[contacts]" in: "query" description: "Filter by contact ids" required: false type: "string" x-exportParamName: "FilterContacts" x-optionalDataType: "String" - name: "filter[deals]" in: "query" description: "Filter by deals ids" required: false type: "string" x-exportParamName: "FilterDeals" x-optionalDataType: "String" - name: "filter[companies]" in: "query" description: "Filter by companies ids" required: false type: "string" x-exportParamName: "FilterCompanies" x-optionalDataType: "String" - name: "dateFrom" in: "query" description: "dateFrom to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateFrom" x-optionalDataType: "Int32" - name: "dateTo" in: "query" description: "dateTo to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateTo" x-optionalDataType: "Int32" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order. Default\ \ order is **descending** by creation if `sort` is not passed" required: false type: "string" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "sortBy" in: "query" description: "The field used to sort field names." required: false type: "string" x-exportParamName: "SortBy" x-optionalDataType: "String" responses: "200": description: "Returns task list with filters" schema: $ref: "#/definitions/TaskList" "400": description: "Returned when query params are invalid" examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" post: tags: - "Tasks" summary: "Create a task" parameters: - in: "body" name: "body" description: "Task name." required: true schema: $ref: "#/definitions/body_6" x-exportParamName: "Body" responses: "201": description: "Created new task" schema: $ref: "#/definitions/inline_response_201_1" "400": description: "Returned when invalid data posted" /crm/tasks/{id}: get: tags: - "Tasks" summary: "Get a task" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returns the Task by id" schema: $ref: "#/definitions/Task" "400": description: "Returned when task id is invalid" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Tasks" summary: "Delete a task" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "Returned when item deleted" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when task id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" patch: tags: - "Tasks" summary: "Update a task" parameters: - name: "id" in: "path" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Updated task details." required: true schema: $ref: "#/definitions/body_7" x-exportParamName: "Body" responses: "204": description: "Task updated successfully" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when task id is not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" /crm/notes: get: tags: - "Notes" summary: "Get all notes" parameters: - name: "entity" in: "query" description: "Filter by note entity type" required: false type: "string" enum: - "companies" - "deals" - "contacts" x-exportParamName: "Entity" x-optionalDataType: "String" - name: "entityIds" in: "query" description: "Filter by note entity IDs" required: false type: "string" x-exportParamName: "EntityIds" x-optionalDataType: "String" - name: "dateFrom" in: "query" description: "dateFrom to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateFrom" x-optionalDataType: "Int32" - name: "dateTo" in: "query" description: "dateTo to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateTo" x-optionalDataType: "Int32" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order. Default\ \ order is **descending** by creation if `sort` is not passed" required: false type: "string" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Returns notes list with filters" schema: $ref: "#/definitions/NoteList" "400": description: "Returned when query params are invalid" examples: response: value: message: "Not valid data." schema: $ref: "#/definitions/errorModel" post: tags: - "Notes" summary: "Create a note" parameters: - in: "body" name: "body" description: "Note data to create a note." required: true schema: $ref: "#/definitions/NoteData" x-exportParamName: "Body" responses: "200": description: "Created new note" schema: $ref: "#/definitions/NoteId" "400": description: "Returned when invalid data posted" examples: application/json: message: "Not valid data." schema: $ref: "#/definitions/errorModel" "415": description: "Format is not supported" examples: application/json: message: "The format not supported for deserialization." schema: $ref: "#/definitions/errorModel" /crm/notes/{id}: get: tags: - "Notes" summary: "Get a note" parameters: - name: "id" in: "path" description: "Note ID to get" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returns the Note by id" schema: $ref: "#/definitions/Note" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Notes" summary: "Delete a note" parameters: - name: "id" in: "path" description: "Note ID to delete" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "Returned when item deleted" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" patch: tags: - "Notes" summary: "Update a note" parameters: - name: "id" in: "path" description: "Note ID to update" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" description: "Note data to update a note" required: true schema: $ref: "#/definitions/NoteData" x-exportParamName: "Body" responses: "204": description: "Note updated successfully" "400": description: "Returned when invalid data posted" examples: application/json: message: "Not valid data." schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" "415": description: "Format is not supported" examples: application/json: message: "The format not supported for deserialization." schema: $ref: "#/definitions/errorModel" /crm/files: get: tags: - "Files" summary: "Get all files" parameters: - name: "entity" in: "query" description: "Filter by file entity type" required: false type: "string" enum: - "companies" - "deals" - "contacts" x-exportParamName: "Entity" x-optionalDataType: "String" - name: "entityIds" in: "query" description: "Filter by file entity IDs" required: false type: "string" x-exportParamName: "EntityIds" x-optionalDataType: "String" - name: "dateFrom" in: "query" description: "dateFrom to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateFrom" x-optionalDataType: "Int32" - name: "dateTo" in: "query" description: "dateTo to date range filter type (timestamp in milliseconds)" required: false type: "integer" x-exportParamName: "DateTo" x-optionalDataType: "Int32" - name: "offset" in: "query" description: "Index of the first document of the page" required: false type: "integer" format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order. Default\ \ order is **descending** by creation if `sort` is not passed" required: false type: "string" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "Returns files list with filters" schema: $ref: "#/definitions/FileList" "400": description: "Returned when query params are invalid" examples: application/json: message: "Not valid data." schema: $ref: "#/definitions/errorModel" post: tags: - "Files" summary: "Upload a file" consumes: - "multipart/form-data" parameters: - name: "file" in: "formData" description: "File data to create a file." required: true type: "file" x-exportParamName: "File" - name: "dealId" in: "formData" description: "Deal id linked to a file" required: false type: "string" x-exportParamName: "DealId" x-optionalDataType: "String" - name: "contactId" in: "formData" description: "Contact id linked to a file" required: false type: "integer" format: "int64" x-exportParamName: "ContactId" x-optionalDataType: "Int64" - name: "companyId" in: "formData" description: "Company id linked to a file" required: false type: "string" x-exportParamName: "CompanyId" x-optionalDataType: "String" responses: "201": description: "Returns the created File with additional details" schema: $ref: "#/definitions/FileData" "400": description: "Returned when invalid data posted" examples: application/json: message: "Invalid deals ids format." schema: $ref: "#/definitions/errorModel" /crm/files/{id}: get: tags: - "Files" summary: "Download a file" parameters: - name: "id" in: "path" description: "File id to download." required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returns downloadable file link. Valid for next 5 minutes only." schema: $ref: "#/definitions/FileDownloadableLink" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Files" summary: "Delete a file" parameters: - name: "id" in: "path" description: "File id to delete." required: true type: "string" x-exportParamName: "Id" responses: "204": description: "Returned when file is deleted." "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" /crm/files/{id}/data: get: tags: - "Files" summary: "Get file details" parameters: - name: "id" in: "path" description: "File id to get file data." required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Returned when file is found." schema: $ref: "#/definitions/FileData" "400": description: "Returned when invalid data posted" examples: application/json: message: "Route attribute id is not valid" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" examples: application/json: message: "Document not found" schema: $ref: "#/definitions/errorModel" /conversations/messages: post: tags: - "Conversations" summary: "Send a message as an agent" consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" description: "Message fields." required: true schema: $ref: "#/definitions/body_8" x-exportParamName: "Body" responses: "200": description: "Newly created message is returned as a response" examples: application/json: id: "eYBEm3gq3zc5ayE2g" type: "agent" text: "Hello! How can I help you?" visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" agentId: "d9nKoegKSjmCtyK78" createdAt: 1482512803740 receivedFrom: "SuperAwesomeHelpdesk" schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" /conversations/messages/{id}: get: tags: - "Conversations" summary: "Get a message" produces: - "application/json" parameters: - name: "id" in: "path" description: "ID of the message" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Requested message is returned as a response" schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Conversations" summary: "Update a message sent by an agent" description: "Only agents’ messages can be edited." consumes: - "application/json" produces: - "application/json" parameters: - name: "id" in: "path" description: "ID of the message" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" required: false schema: $ref: "#/definitions/body_9" x-exportParamName: "Body" responses: "200": description: "Updated message is returned as a response" examples: application/json: id: "eYBEm3gq3zc5ayE2g" type: "agent" text: "Hello! How can I help you?" visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" agentId: "d9nKoegKSjmCtyK78" createdAt: 1482512803740 receivedFrom: "SuperAwesomeHelpdesk" schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Conversations" summary: "Delete a message sent by an agent" description: "Only agents’ messages can be deleted." parameters: - name: "id" in: "path" description: "ID of the message" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "The message was deleted from the conversation" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" /conversations/pushedMessages: post: tags: - "Conversations" summary: "Send an automated message to a visitor" description: "Example of automated messages: order status, announce new features\ \ in your web app, etc." consumes: - "application/json" produces: - "application/json" parameters: - in: "body" name: "body" required: true schema: $ref: "#/definitions/body_10" x-exportParamName: "Body" responses: "200": description: "Newly created message is returned as a response" examples: application/json: 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 schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" /conversations/pushedMessages/{id}: get: tags: - "Conversations" summary: "Get an automated message" produces: - "application/json" parameters: - name: "id" in: "path" description: "ID of the message sent previously" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Requested message is returned as a response" schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" put: tags: - "Conversations" summary: "Update an automated message" parameters: - name: "id" in: "path" description: "ID of the message" required: true type: "string" x-exportParamName: "Id" - in: "body" name: "body" required: true schema: $ref: "#/definitions/body_11" x-exportParamName: "Body" responses: "200": description: "Updated message is returned as a response" examples: application/json: 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 schema: $ref: "#/definitions/ConversationsMessage" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "Conversations" summary: "Delete an automated message" parameters: - name: "id" in: "path" description: "ID of the message" required: true type: "string" x-exportParamName: "Id" responses: "204": description: "The message was deleted from the conversation" "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" "404": description: "Returned when item not found" schema: $ref: "#/definitions/errorModel" /conversations/agentOnlinePing: post: tags: - "Conversations" 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." consumes: - "application/json" parameters: - in: "body" name: "body" description: "Agent fields." required: true schema: $ref: "#/definitions/body_12" x-exportParamName: "Body" responses: "201": description: "Status of the agent was set successfully. Response body will\ \ be empty." "400": description: "Returned when invalid data posted" schema: $ref: "#/definitions/errorModel" /ecommerce/activate: post: tags: - "Ecommerce" summary: "Activate the eCommerce app" description: "Getting access to Brevo eCommerce." parameters: [] responses: "200": description: "eCommerce activation is in process, please wait for 5 minutes." "401": description: "unauthorized" schema: $ref: "#/definitions/errorModel" "404": description: "api-key not found" schema: $ref: "#/definitions/errorModel" /orders/status: post: tags: - "Ecommerce" summary: "Managing the status of the order" description: "Manages the transactional status of the order" operationId: "createOrder" parameters: - in: "body" name: "order" required: true schema: $ref: "#/definitions/order" x-exportParamName: "Order" responses: "204": description: "Order Event posted" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /orders/status/batch: post: tags: - "Ecommerce" summary: "Create orders in batch" description: "Create multiple orders at one time instead of one order at a time" operationId: "createBatchOrder" parameters: - in: "body" name: "orderBatch" required: true schema: $ref: "#/definitions/orderBatch" x-exportParamName: "OrderBatch" responses: "202": $ref: "#/definitions/createdBatchId" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /categories: get: tags: - "Ecommerce" summary: "Return all your categories" operationId: "getCategories" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 100 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "ids" in: "query" description: "Filter by category ids" required: false type: "array" items: type: "string" x-exportParamName: "Ids" - name: "name" in: "query" description: "Filter by category name" required: false type: "string" x-exportParamName: "Name" x-optionalDataType: "String" responses: "200": description: "All categories listed" examples: application/json: categories: - id: 19 name: "Food" url: "https://mydomain.com/category/food" modifiedAt: "2022-03-03T14:48:31.867Z" createdAt: "2021-12-31T11:42:35.638Z" - id: 20 name: "clothing" url: "https://mydomain.com/category/food" modifiedAt: "2022-03-03T14:48:31.867Z" createdAt: "2021-12-31T11:42:35.638Z" isDeleted: true count: 2 schema: $ref: "#/definitions/getCategories" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Ecommerce" summary: "Create/Update a category" operationId: "createUpdateCategory" parameters: - in: "body" name: "createUpdateCategory" description: "Values to create/update a category" required: true schema: $ref: "#/definitions/createUpdateCategory" x-exportParamName: "CreateUpdateCategory" responses: "201": description: "Category created" schema: $ref: "#/definitions/createCategoryModel" "204": description: "Category updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /categories/{id}: get: tags: - "Ecommerce" summary: "Get a category details" operationId: "getCategoryInfo" parameters: - name: "id" in: "path" description: "Category ID" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Category informations" schema: $ref: "#/definitions/getCategoryDetails" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Category id not found" schema: $ref: "#/definitions/errorModel" /categories/batch: post: tags: - "Ecommerce" summary: "Create categories in batch" operationId: "createUpdateBatchCategory" parameters: - in: "body" name: "createUpdateBatchCategory" description: "Values to create a batch of categories" required: true schema: $ref: "#/definitions/createUpdateBatchCategory" x-exportParamName: "CreateUpdateBatchCategory" responses: "201": description: "Category created and updated" schema: $ref: "#/definitions/createUpdateBatchCategoryModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /products: get: tags: - "Ecommerce" summary: "Return all your products" operationId: "getProducts" parameters: - name: "limit" in: "query" description: "Number of documents per page" required: false type: "integer" default: 50 maximum: 1000 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document in the page" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "ids" in: "query" description: "Filter by product ids" required: false type: "array" items: type: "string" x-exportParamName: "Ids" - name: "name" in: "query" description: "Filter by product name, minimum 3 characters should be present\ \ for search" required: false type: "string" x-exportParamName: "Name" x-optionalDataType: "String" - name: "price[lte]" in: "query" description: "Price filter for products less than and equals to particular\ \ amount" required: false type: "number" x-exportParamName: "PriceLte" x-optionalDataType: "Float32" - name: "price[gte]" in: "query" description: "Price filter for products greater than and equals to particular\ \ amount" required: false type: "number" x-exportParamName: "PriceGte" x-optionalDataType: "Float32" - name: "price[lt]" in: "query" description: "Price filter for products less than particular amount" required: false type: "number" x-exportParamName: "PriceLt" x-optionalDataType: "Float32" - name: "price[gt]" in: "query" description: "Price filter for products greater than particular amount" required: false type: "number" x-exportParamName: "PriceGt" x-optionalDataType: "Float32" - name: "price[eq]" in: "query" description: "Price filter for products equals to particular amount" required: false type: "number" x-exportParamName: "PriceEq" x-optionalDataType: "Float32" - name: "price[ne]" in: "query" description: "Price filter for products not equals to particular amount" required: false type: "number" x-exportParamName: "PriceNe" x-optionalDataType: "Float32" - name: "categories" in: "query" description: "Filter by category ids" required: false type: "array" items: type: "string" x-exportParamName: "Categories" responses: "200": description: "All products listed" examples: application/json: 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" isDeleted: true count: 2 schema: $ref: "#/definitions/getProducts" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" post: tags: - "Ecommerce" summary: "Create/Update a product" operationId: "createUpdateProduct" parameters: - in: "body" name: "createUpdateProduct" description: "Values to create/update a product" required: true schema: $ref: "#/definitions/createUpdateProduct" x-exportParamName: "CreateUpdateProduct" responses: "201": description: "Product created" examples: application/json: id: 21 schema: $ref: "#/definitions/createProductModel" "204": description: "Product updated" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /products/{id}: get: tags: - "Ecommerce" summary: "Get a product's details" operationId: "getProductInfo" parameters: - name: "id" in: "path" description: "Product ID" required: true type: "string" x-exportParamName: "Id" responses: "200": description: "Product informations" schema: $ref: "#/definitions/getProductDetails" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Product's id not found" schema: $ref: "#/definitions/errorModel" /products/batch: post: tags: - "Ecommerce" summary: "Create products in batch" operationId: "createUpdateBatchProducts" parameters: - in: "body" name: "createUpdateBatchProducts" description: "Values to create a batch of products" required: true schema: $ref: "#/definitions/createUpdateBatchProducts" x-exportParamName: "CreateUpdateBatchProducts" responses: "201": description: "Products created and updated" examples: application/json: createdCount: 2 updatedCount: 7 schema: $ref: "#/definitions/createUpdateBatchProductsModel" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsapp/sendMessage: post: tags: - "Transactional WhatsApp" summary: "Send a WhatsApp message" description: "This endpoint is used to send a WhatsApp message.
(**The\ \ first message you send using the API must contain a Template ID. You must\ \ create a template on WhatsApp on the Brevo platform to fetch the Template\ \ ID.**)" operationId: "sendWhatsappMessage" parameters: - in: "body" name: "sendWhatsappMessage" description: "Values to send WhatsApp message" required: true schema: $ref: "#/definitions/sendWhatsappMessage" x-exportParamName: "SendWhatsappMessage" responses: "201": description: "successfully created" schema: $ref: "#/definitions/inline_response_201_2" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /whatsapp/statistics/events: get: tags: - "Transactional WhatsApp" summary: "Get all your WhatsApp activity (unaggregated events)" description: "This endpoint will show the unaggregated statistics for WhatsApp\ \ activity (30 days by default if `startDate` and `endDate` or `days` is not\ \ passed. The date range can not exceed 90 days)" operationId: "getWhatsappEventReport" parameters: - name: "limit" in: "query" description: "Number limitation for the result returned" required: false type: "integer" default: 2500 maximum: 5000 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Beginning point in the list to retrieve from" required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" - name: "startDate" in: "query" description: "**Mandatory if endDate is used.** Starting date of the report\ \ (YYYY-MM-DD). Must be lower than equal to endDate\n" required: false type: "string" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" description: "**Mandatory if startDate is used.** Ending date of the report\ \ (YYYY-MM-DD). Must be greater than equal to startDate\n" required: false type: "string" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "days" in: "query" description: "Number of days in the past including today (positive integer).\ \ _Not compatible with 'startDate' and 'endDate'_\n" required: false type: "integer" format: "int64" x-exportParamName: "Days" x-optionalDataType: "Int64" - name: "contactNumber" in: "query" description: "Filter results for specific contact (WhatsApp Number with country\ \ code. Example, 85264318721)" required: false type: "string" format: "mobile" x-exportParamName: "ContactNumber" x-optionalDataType: "String" - name: "event" in: "query" description: "Filter the report for a specific event type" required: false type: "string" enum: - "sent" - "delivered" - "read" - "error" - "unsubscribe" - "reply" - "soft-bounce" x-exportParamName: "Event" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed" required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" responses: "200": description: "WhatsApp events report" examples: application/json: response: value: events: - contactNumber: 919876543211 date: "2017-03-12T12:30:00.000+0000" messageId: "23befbae-1505-47a8-bd27-e30ef739f32c" event: "sent" senderNumber: 919876543210 - contactNumber: 919876543211 date: "2017-03-12T12:30:00.000+0000" messageId: "23befbae-1505-47a8-bd27-e30ef739f32c" event: "error" reason: "error reason" senderNumber: 919876543210 - contactNumber: 919876543211 date: "2017-03-12T12:30:00.000+0000" messageId: "23befbae-1505-47a8-bd27-e30ef739f32c" event: "soft-bounce" reason: "invalid whatsapp contact" senderNumber: 919876543210 - contactNumber: 919876543211 date: "2017-03-12T12:30:00.000+0000" messageId: "23befbae-1505-47a8-bd27-e30ef739f32c" event: "reply" body: "body only in case of text reply & url will be empty" mediaUrl: "media url only in case media reply & body will be empty" senderNumber: 919876543210 schema: $ref: "#/definitions/getWhatsappEventReport" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /feeds: get: tags: - "External Feeds" summary: "Fetch all external feeds" description: "This endpoint can fetch all created external feeds." operationId: "getAllExternalFeeds" parameters: - name: "search" in: "query" description: "Can be used to filter records by search keyword on feed name" required: false type: "string" x-exportParamName: "Search" x-optionalDataType: "String" - name: "startDate" in: "query" description: "Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from\ \ which you want to fetch the list. Can be maximum 30 days older than current\ \ date." required: false type: "string" format: "date" x-exportParamName: "StartDate" x-optionalDataType: "String" - name: "endDate" in: "query" 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." required: false type: "string" format: "date" x-exportParamName: "EndDate" x-optionalDataType: "String" - name: "sort" in: "query" description: "Sort the results in the ascending/descending order of record\ \ creation. Default order is **descending** if `sort` is not passed." required: false type: "string" default: "desc" enum: - "asc" - "desc" x-exportParamName: "Sort" x-optionalDataType: "String" - name: "authType" in: "query" description: "Filter the records by `authType` of the feed." required: false type: "string" enum: - "basic" - "token" - "noAuth" x-exportParamName: "AuthType" x-optionalDataType: "String" - name: "limit" in: "query" description: "Number of documents returned per page." required: false type: "integer" default: 50 maximum: 500 minimum: 0 format: "int64" x-exportParamName: "Limit" x-optionalDataType: "Int64" - name: "offset" in: "query" description: "Index of the first document on the page." required: false type: "integer" default: 0 format: "int64" x-exportParamName: "Offset" x-optionalDataType: "Int64" responses: "200": description: "External feeds" examples: application/json: count: 3 feeds: - id: "d955aaa4-f4d6-4557-aa14-24286542ed8d" name: "api feed token" url: "https://abc.com/" authType: "token" token: "jfhdkjdfhjkfdhjkdfhjkdfhkj" headers: - name: "key" value: "val" maxRetries: 4 cache: true createdAt: "2022-10-06T05:03:47.053000000Z" modifiedAt: "2022-10-06T05:03:47.053000000Z" - id: "311a71ac-bebc-42cf-963d-d8666dfe53e9" name: "api feed basic" url: "https://abc.com/" authType: "basic" username: "user" password: "pass" maxRetries: 2 cache: false createdAt: "2022-10-06T04:48:19.767000000Z" modifiedAt: "2022-10-06T04:48:19.767000000Z" schema: $ref: "#/definitions/getAllExternalFeeds" "400": description: "Invalid parameters passed" schema: $ref: "#/definitions/errorModel" "404": description: "Record not found" schema: $ref: "#/definitions/errorModel" post: tags: - "External Feeds" summary: "Create an external feed" description: "This endpoint will create an external feed." operationId: "createExternalFeed" parameters: - in: "body" name: "createExternalFeed" description: "Values to create a feed" required: true schema: $ref: "#/definitions/createExternalFeed" x-exportParamName: "CreateExternalFeed" responses: "201": description: "successfully created" schema: $ref: "#/definitions/inline_response_201_3" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" /feeds/{uuid}: get: tags: - "External Feeds" summary: "Get an external feed by UUID" description: "This endpoint will update an external feed." operationId: "getExternalFeedByUUID" parameters: - name: "uuid" in: "path" description: "UUID of the feed to fetch" required: true type: "string" x-exportParamName: "Uuid" responses: "200": description: "External feed" examples: application/json: id: "d955aaa4-f4d6-4557-aa14-24286542ed8d" name: "api feed token" url: "https://abc.com/" authType: "token" token: "jfhdkjdfhjkfdhjkdfhjkdfhkj" headers: - name: "key" value: "val" maxRetries: 4 cache: true createdAt: "2022-10-06T05:03:47.053000000Z" modifiedAt: "2022-10-06T05:03:47.053000000Z" schema: $ref: "#/definitions/getExternalFeedByUUID" "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Feed not found" schema: $ref: "#/definitions/errorModel" put: tags: - "External Feeds" summary: "Update an external feed" description: "This endpoint will update an external feed." operationId: "updateExternalFeed" parameters: - name: "uuid" in: "path" description: "UUID of the feed to update" required: true type: "string" x-exportParamName: "Uuid" - in: "body" name: "updateExternalFeed" description: "Values to update a feed" required: true schema: $ref: "#/definitions/updateExternalFeed" x-exportParamName: "UpdateExternalFeed" responses: "204": description: "Feed updated" examples: application/json: {} "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Feed not found" schema: $ref: "#/definitions/errorModel" delete: tags: - "External Feeds" summary: "Delete an external feed" description: "This endpoint will delete an external feed." operationId: "deleteExternalFeed" parameters: - name: "uuid" in: "path" description: "UUID of the feed to delete" required: true type: "string" x-exportParamName: "Uuid" responses: "204": description: "Feed deleted" examples: application/json: {} "400": description: "bad request" schema: $ref: "#/definitions/errorModel" "404": description: "Feed not found" schema: $ref: "#/definitions/errorModel" securityDefinitions: api-key: description: "The API key should be passed in the request headers as `api-key`\ \ for authentication." type: "apiKey" name: "api-key" in: "header" partner-key: description: "The partner key should be passed in the request headers as `partner-key`\ \ along with `api-key` pair for successful authentication of partner (Optional)." type: "apiKey" name: "partner-key" in: "header" definitions: getAccount: allOf: - $ref: "#/definitions/getExtendedClient" - type: "object" required: - "plan" - "relay" properties: plan: type: "array" description: "Information about your plans and credits" items: $ref: "#/definitions/getAccount_plan" relay: $ref: "#/definitions/getAccount_relay" marketingAutomation: $ref: "#/definitions/getAccount_marketingAutomation" getAccountActivity: type: "object" properties: logs: type: "array" description: "Get user activity logs" items: $ref: "#/definitions/getAccountActivity_logs" getChildrenList: type: "object" properties: children: type: "array" description: "Your children's account information" items: type: "object" allOf: - $ref: "#/definitions/getChildInfo" - type: "object" properties: id: type: "integer" format: "int64" example: 187588 description: "ID of the child" count: type: "integer" format: "int64" example: 24 description: "Number of child accounts" getChildInfo: allOf: - $ref: "#/definitions/getClient" - type: "object" required: - "password" properties: credits: $ref: "#/definitions/getChildInfo_credits" statistics: $ref: "#/definitions/getChildInfo_statistics" password: type: "string" format: "password" example: "abC01De2fGHI3jkL" description: "The encrypted password of child account" ips: type: "array" description: "IP(s) associated to a child account user" items: type: "string" example: "" description: "IP(s) associated to the user" apiKeys: $ref: "#/definitions/getChildInfo_apiKeys" getChildAccountCreationStatus: type: "object" required: - "childAccountCreated" properties: childAccountCreated: type: "boolean" example: true description: "Status of child account creation whether it is successfully\ \ created (exists) or not." getChildDomains: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getChildDomain" getSsoToken: type: "object" required: - "token" properties: token: type: "string" example: "ede520dxxxxxxxxxxxx76d631fba2" description: "Session token, it will remain valid for 15 days." getChildDomain: type: "object" properties: domain: type: "string" example: "mycustomdomain.com" description: "Sender domain" active: type: "boolean" example: true description: "indicates whether a domain is verified or not" getClient: type: "object" required: - "companyName" - "email" - "firstName" - "lastName" properties: email: type: "string" format: "email" example: "john.smith@example.com" description: "Login Email" firstName: type: "string" example: "John" description: "First Name" lastName: type: "string" example: "Smith" description: "Last Name" companyName: type: "string" example: "MyCompany" description: "Name of the company" getExtendedClient: allOf: - $ref: "#/definitions/getClient" - type: "object" required: - "address" properties: address: $ref: "#/definitions/getExtendedClient_address" getSendersList: type: "object" properties: senders: type: "array" description: "List of the senders available in your account" items: $ref: "#/definitions/getSendersList_senders" getDomainsList: type: "object" properties: domains: type: "array" description: "List of the domains available in your account" items: $ref: "#/definitions/getDomainsList_domains" createChild: type: "object" required: - "companyName" - "email" - "firstName" - "lastName" - "password" properties: email: type: "string" format: "email" example: "josh.cruise@example.com" description: "Email address to create the child account" firstName: type: "string" example: "Josh" description: "First name to use to create the child account" lastName: type: "string" example: "Cruise" description: "Last name to use to create the child account" companyName: type: "string" example: "Your Company" description: "Company name to use to create the child account" password: type: "string" format: "password" example: "Pa55w0rd65" description: "Password for the child account to login" language: type: "string" example: "en" description: "Language of the child account" enum: - "fr" - "es" - "pt" - "it" - "de" - "en" createSender: type: "object" required: - "email" - "name" properties: name: type: "string" example: "Newsletter" description: "From Name to use for the sender" email: type: "string" format: "email" example: "newsletter@mycompany.com" description: "From email to use for the sender. A verification email will\ \ be sent to this address." ips: type: "array" description: "Mandatory in case of dedicated IP, IPs to associate to the sender" items: $ref: "#/definitions/createSender_ips" updateSender: type: "object" properties: name: type: "string" example: "Newsletter" description: "From Name to update the sender" email: type: "string" format: "email" example: "newsletter@mycompany.com" description: "From Email to update the sender" ips: type: "array" description: "Only in case of dedicated IP, IPs to associate to the sender.\ \ If passed, will replace all the existing IPs." items: $ref: "#/definitions/createSender_ips" otp: type: "object" properties: name: type: "integer" example: 123456 description: "6 digit OTP received on email" createDomain: type: "object" required: - "name" properties: name: type: "string" example: "mycompany.com" description: "Domain name" updateChild: type: "object" properties: email: type: "string" format: "email" example: "josh.cruise@example.com" description: "New Email address to update the child account" firstName: type: "string" example: "Josh" description: "New First name to use to update the child account" lastName: type: "string" example: "Cruise" description: "New Last name to use to update the child account" companyName: type: "string" example: "Your Company" description: "New Company name to use to update the child account" password: type: "string" format: "password" example: "Pa55w0rd65" description: "New password for the child account to login" updateChildAccountStatus: type: "object" properties: transactionalEmail: type: "boolean" example: false description: "Status of Transactional Email Platform activation for your account\ \ (true=enabled, false=disabled)" transactionalSms: type: "boolean" example: false description: "Status of Transactional SMS Platform activation for your account\ \ (true=enabled, false=disabled)" marketingAutomation: type: "boolean" example: true description: "Status of Marketing Automation Platform activation for your\ \ account (true=enabled, false=disabled)" smsCampaign: type: "boolean" example: true description: "Status of SMS Campaign Platform activation for your account\ \ (true=enabled, false=disabled)" errorModel: type: "object" required: - "code" - "message" properties: code: type: "string" example: "method_not_allowed" description: "Error code displayed in case of a failure" enum: - "invalid_parameter" - "missing_parameter" - "out_of_range" - "campaign_processing" - "campaign_sent" - "document_not_found" - "reseller_permission_denied" - "not_enough_credits" - "permission_denied" - "duplicate_parameter" - "duplicate_request" - "method_not_allowed" - "unauthorized" - "account_under_validation" - "not_acceptable" - "bad_request" message: type: "string" example: "POST Method is not allowed on this path" description: "Readable message associated to the failure" remainingCreditModel: type: "object" required: - "child" - "reseller" properties: child: $ref: "#/definitions/remainingCreditModel_child" reseller: $ref: "#/definitions/remainingCreditModel_reseller" addCredits: type: "object" properties: sms: type: "integer" format: "int64" example: 450 description: "Required if email credits are empty. SMS credits to be added\ \ to the child account" email: type: "integer" format: "int64" example: 1200 description: "Required if sms credits are empty. Email credits to be added\ \ to the child account" removeCredits: type: "object" properties: sms: type: "integer" format: "int64" example: 300 description: "Required if email credits are empty. SMS credits to be removed\ \ from the child account" email: type: "integer" format: "int64" example: 500 description: "Required if sms credits are empty. Email credits to be removed\ \ from the child account" addChildDomain: type: "object" properties: domain: type: "string" example: "mychilddomain.com" description: "Sender domain to add for a specific child account" updateChildDomain: type: "object" properties: domain: type: "string" example: "myupdateddomain.com" description: "Value for the sender domain that will replace the existing domain" getProcesses: type: "object" properties: processes: type: "array" description: "List of processes available on your account" items: $ref: "#/definitions/getProcess" count: type: "integer" format: "int64" example: 5 description: "Number of processes available on your account" getProcess: type: "object" required: - "id" - "name" - "status" properties: id: type: "integer" format: "int64" example: 145 description: "Id of the process" status: type: "string" example: "queued" description: "Status of the process" enum: - "queued" - "in_process" - "completed" name: type: "string" example: "IMPORTUSER" description: "Process name" export_url: type: "string" example: "http://requestb.in/16ua3aj1" description: "URL on which send export the of contacts once the process is\ \ completed" getEmailCampaigns: type: "object" properties: campaigns: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getExtendedCampaignOverview" - type: "object" properties: recipients: type: "object" allOf: - $ref: "#/definitions/getCampaignRecipients" statistics: type: "object" allOf: - $ref: "#/definitions/getExtendedCampaignStats" shareLink: type: "string" format: "url" example: "http://dhh.brevo.com/fhsgccc.html?t=9865448900" description: "Link to share the campaign on social medias" required: - "recipients" - "statistics" count: type: "integer" format: "int64" example: 24 description: "Number of Email campaigns retrieved" getSmsCampaigns: type: "object" properties: campaigns: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getSmsCampaignOverview" - type: "object" properties: recipients: type: "object" allOf: - $ref: "#/definitions/getCampaignRecipients" statistics: type: "object" allOf: - $ref: "#/definitions/getSmsCampaignStats" required: - "recipients" - "statistics" count: type: "integer" format: "int64" example: 12 description: "Number of SMS campaigns retrieved" getSmsCampaign: allOf: - $ref: "#/definitions/getSmsCampaignOverview" - type: "object" required: - "recipients" - "statistics" properties: recipients: type: "object" allOf: - $ref: "#/definitions/getCampaignRecipients" statistics: type: "object" allOf: - $ref: "#/definitions/getSmsCampaignStats" getEmailCampaign: allOf: - $ref: "#/definitions/getExtendedCampaignOverview" - type: "object" required: - "recipients" - "statistics" properties: recipients: type: "object" allOf: - $ref: "#/definitions/getCampaignRecipients" statistics: type: "object" allOf: - $ref: "#/definitions/getExtendedCampaignStats" getCampaignOverview: type: "object" required: - "id" - "name" - "status" - "type" properties: id: type: "integer" format: "int64" example: 12 description: "ID of the campaign" name: type: "string" example: "EN - Sales Summer 2017" description: "Name of the campaign" subject: type: "string" example: "20% OFF for 2017 Summer Sales" description: "Subject of the campaign. Only available if `abTesting` flag\ \ of the campaign is `false`" type: type: "string" example: "classic" description: "Type of campaign" enum: - "classic" - "trigger" status: type: "string" example: "sent" description: "Status of the campaign" enum: - "draft" - "sent" - "archive" - "queued" - "suspended" - "in_process" scheduledAt: type: "string" example: "2017-06-01T12:30:00Z" description: "UTC date-time on which campaign is scheduled (YYYY-MM-DDTHH:mm:ss.SSSZ)" abTesting: type: "boolean" example: true description: "Status of A/B Test for the campaign. abTesting = false means\ \ it is disabled, & abTesting = true means it is enabled." subjectA: type: "string" example: "Discover the New Collection!" description: "Subject A of the ab-test campaign. Only available if `abTesting`\ \ flag of the campaign is `true`" subjectB: type: "string" example: "Want to discover the New Collection?" description: "Subject B of the ab-test campaign. Only available if `abTesting`\ \ flag of the campaign is `true`" splitRule: type: "integer" example: 25 description: "The size of your ab-test groups. Only available if `abTesting`\ \ flag of the campaign is `true`" winnerCriteria: type: "string" example: "open" description: "Criteria for the winning version. Only available if `abTesting`\ \ flag of the campaign is `true`" winnerDelay: type: "integer" example: 50 description: "The duration of the test in hours at the end of which the winning\ \ version will be sent. Only available if `abTesting` flag of the campaign\ \ is `true`" sendAtBestTime: type: "boolean" example: true description: "It is true if you have chosen to send your campaign at best\ \ time, otherwise it is false" getExtendedCampaignOverview: allOf: - $ref: "#/definitions/getCampaignOverview" - type: "object" required: - "createdAt" - "footer" - "header" - "htmlContent" - "modifiedAt" - "replyTo" - "sender" - "testSent" properties: testSent: type: "boolean" example: true description: "Retrieved the status of test email sending. (true=Test email\ \ has been sent false=Test email has not been sent)" header: type: "string" example: "[DEFAULT_HEADER]" description: "Header of the campaign" footer: type: "string" example: "[DEFAULT_FOOTER]" description: "Footer of the campaign" sender: $ref: "#/definitions/getExtendedCampaignOverview_sender" replyTo: type: "string" format: "email" example: "replyto@domain.com" description: "Email defined as the \"Reply to\" of the campaign" toField: type: "string" example: "{FNAME} {LNAME}" description: "Customisation of the \"to\" field of the campaign" htmlContent: type: "string" example: "This is my HTML Content" description: "HTML content of the campaign" shareLink: type: "string" format: "url" example: "http://dhh.brevo.com/fhsgccc.html?t=9865448900" description: "Link to share the campaign on social medias" tag: type: "string" example: "Newsletter" description: "Tag of the campaign" createdAt: type: "string" example: "2017-05-01T12:30:00Z" description: "Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-01T12:30:00Z" description: "UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" inlineImageActivation: type: "boolean" example: true description: "Status of inline image. inlineImageActivation = false means\ \ image can’t be embedded, & inlineImageActivation = true means image\ \ can be embedded, in the email." mirrorActive: type: "boolean" example: true description: "Status of mirror links in campaign. mirrorActive = false means\ \ mirror links are deactivated, & mirrorActive = true means mirror links\ \ are activated, in the campaign" recurring: type: "boolean" example: true description: "FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false\ \ means contact can receive the same Trigger campaign only once, & recurring\ \ = true means contact can receive the same Trigger campaign several times" sentDate: type: "string" example: "2018-12-01T16:30:00Z" description: "Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ).\ \ Only available if 'status' of the campaign is 'sent'" returnBounce: type: "integer" format: "int64" example: 5 description: "Total number of non-delivered campaigns for a particular campaign\ \ id." getCampaignRecipients: type: "object" required: - "exclusionLists" - "lists" properties: lists: type: "array" items: type: "integer" format: "int64" example: 21 description: "List IDs included in the campaign" exclusionLists: type: "array" items: type: "integer" format: "int64" example: 13 description: "List IDs excluded of the campaign" getExtendedCampaignStats: type: "object" required: - "campaignStats" - "globalStats" - "linksStats" - "mirrorClick" - "remaining" - "statsByBrowser" - "statsByDevice" - "statsByDomain" properties: globalStats: type: "object" description: "Overall statistics of the campaign" allOf: - $ref: "#/definitions/getCampaignStats" campaignStats: type: "array" description: "List-wise statistics of the campaign." items: type: "object" allOf: - $ref: "#/definitions/getCampaignStats" mirrorClick: type: "integer" format: "int64" example: 120 description: "Number of clicks on mirror link" remaining: type: "integer" format: "int64" example: 1000 description: "Number of remaning emails to send" linksStats: type: "object" example: example.abc.com: 7 example.domain.com: 10 description: "Statistics about the number of clicks for the links" properties: {} statsByDomain: $ref: "#/definitions/getStatsByDomain" statsByDevice: description: "Statistics about the campaign on the basis of various devices" $ref: "#/definitions/getStatsByDevice" statsByBrowser: description: "Statistics about the campaign on the basis of various browsers" $ref: "#/definitions/getStatsByBrowser" getStatsByDomain: type: "object" additionalProperties: $ref: "#/definitions/getCampaignStats" getStatsByDevice: type: "object" properties: desktop: type: "object" description: "Statistics of the campaign on the basis of desktop devices" additionalProperties: $ref: "#/definitions/getDeviceBrowserStats" mobile: type: "object" description: "Statistics of the campaign on the basis of mobile devices" additionalProperties: $ref: "#/definitions/getDeviceBrowserStats" tablet: type: "object" description: "Statistics of the campaign on the basis of tablet devices" additionalProperties: $ref: "#/definitions/getDeviceBrowserStats" unknown: type: "object" description: "Statistics of the campaign on the basis of unknown devices" additionalProperties: $ref: "#/definitions/getDeviceBrowserStats" getStatsByBrowser: type: "object" additionalProperties: $ref: "#/definitions/getDeviceBrowserStats" addContactToList: type: "object" properties: emails: type: "array" description: "Mandatory if IDs are not passed, ignored otherwise. Emails to\ \ add to a list. You can pass a maximum of 150 emails for addition in one\ \ request. If you need to add the emails in bulk, please prefer /contacts/import\ \ api." items: type: "string" format: "email" example: "john.smith@contact.com" description: "Emails addresses OR IDs of the contacts" maxItems: 150 minItems: 1 ids: type: "array" description: "Mandatory if Emails are not passed, ignored otherwise. Emails\ \ to add to a list. You can pass a maximum of 150 emails for addition in\ \ one request. If you need to add the emails in bulk, please prefer /contacts/import\ \ api." items: type: "integer" format: "int64" example: 121 description: "IDs of the contacts" maxItems: 150 minItems: 1 removeContactFromList: type: "object" properties: emails: type: "array" description: "Required if 'all' is false. Emails to remove from a list. You\ \ can pass a maximum of 150 emails for removal in one request." items: type: "string" example: "john.smith@contact.com OR 151" description: "Emails addresses OR IDs of the contacts" maxItems: 150 minItems: 1 ids: type: "array" description: "Mandatory if Emails are not passed, ignored otherwise. Emails\ \ to add to a list. You can pass a maximum of 150 emails for addition in\ \ one request. If you need to add the emails in bulk, please prefer /contacts/import\ \ api." items: type: "integer" format: "int64" example: 121 description: "IDs of the contacts" maxItems: 150 minItems: 1 all: type: "boolean" example: false description: "Required if none of 'emails' or 'ids' are passed. Remove all\ \ existing contacts from a list. A process will be created in this scenario.\ \ You can fetch the process details to know about the progress" getSmsCampaignOverview: type: "object" required: - "content" - "createdAt" - "id" - "modifiedAt" - "name" - "sender" - "status" properties: id: type: "integer" format: "int64" example: 2 description: "ID of the SMS Campaign" name: type: "string" example: "PROMO CODE" description: "Name of the SMS Campaign" status: type: "string" example: "draft" description: "Status of the SMS Campaign" enum: - "draft" - "sent" - "archive" - "queued" - "suspended" - "inProcess" content: type: "string" example: "Visit our Store and get some discount !" description: "Content of the SMS Campaign" scheduledAt: type: "string" example: "2017-06-01T12:30:00Z" description: "UTC date-time on which SMS campaign is scheduled. Should be\ \ in YYYY-MM-DDTHH:mm:ss.SSSZ format" sender: type: "string" example: "MyCompany" description: "Sender of the SMS Campaign" createdAt: type: "string" example: "2017-06-01T12:30:00Z" description: "Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-01T12:30:00Z" description: "UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" getWhatsappCampaignOverview: type: "object" required: - "campaignName" - "campaignStatus" - "createdAt" - "id" - "modifiedAt" - "senderNumber" - "template" properties: id: type: "integer" format: "int64" example: 1672035851100690 description: "ID of the WhatsApp Campaign" campaignName: type: "string" example: "Test Campaign" description: "Name of the WhatsApp Campaign" campaignStatus: type: "string" example: "draft" description: "Status of the WhatsApp Campaign" enum: - "draft" - "scheduled" - "pending" - "approved" - "running" - "suspended" - "rejected" - "sent" scheduledAt: type: "string" example: "2017-06-01T12:30:00.000+0000" description: "UTC date-time on which WhatsApp campaign is scheduled. Should\ \ be in YYYY-MM-DDTHH:mm:ss.SSSZ format" senderNumber: type: "string" example: "9368207029" description: "Sender of the WhatsApp Campaign" stats: $ref: "#/definitions/WhatsappCampStats" template: $ref: "#/definitions/WhatsappCampTemplate" createdAt: type: "string" example: "2017-06-01T12:30:00.000+0000" description: "Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-01T12:30:00.000+0000" description: "UTC date-time of last modification of the WhatsApp campaign\ \ (YYYY-MM-DDTHH:mm:ss.SSSZ)" WhatsappCampStats: type: "object" required: - "delivered" - "not_sent" - "read" - "sent" - "unsubscribe" properties: sent: type: "integer" example: 3 delivered: type: "integer" example: 3 read: type: "integer" example: 2 unsubscribe: type: "integer" example: 0 not_sent: type: "integer" example: 4 WhatsappCampTemplate: type: "object" properties: name: type: "string" example: "wta107" description: "name of the template" category: type: "string" example: "Marketing" description: "description of the template" language: type: "string" example: "en_GB" description: "language of the template" contains_button: type: "boolean" example: false display_header: type: "boolean" example: true header_type: type: "string" example: "text" description: "type of header" components: type: "array" description: "array of component item objects" items: $ref: "#/definitions/componentItems" header_variables: type: "array" description: "array of variables item object" items: $ref: "#/definitions/variablesItems" body_variables: type: "array" description: "array of variables item variables" items: $ref: "#/definitions/variablesItems" button_type: type: "string" example: "QUICK_REPLIES" hide_footer: type: "boolean" example: true componentItems: type: "object" properties: type: type: "string" example: "BODY" text: type: "string" example: "Life is a long lesson in humility" variablesItems: type: "object" properties: name: type: "string" example: "FIRSTNAME" default: type: "string" example: "INVALID_HEADER" datatype: type: "string" example: "text" bodyVariablesItems: type: "object" getWATemplates: type: "object" required: - "count" - "templates" properties: templates: type: "array" items: $ref: "#/definitions/getWATemplates_templates" count: type: "integer" format: "int64" example: 24 description: "Number of whatsApp templates retrived" getWhatsappCampaigns: type: "object" properties: campaigns: type: "array" items: $ref: "#/definitions/getWhatsappCampaigns_campaigns" count: type: "integer" format: "int64" example: 24 description: "Number of WhatsApp campaigns retrived" createWhatsAppCampaign: type: "object" required: - "name" - "recipients" - "scheduledAt" - "templateId" properties: name: type: "string" example: "Test Campaign" description: "Name of the WhatsApp campaign creation" templateId: type: "integer" example: 19 description: "Id of the WhatsApp template in **approved** state" scheduledAt: type: "string" example: "2017-06-01T10:30:00.000+0000" description: "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). **Prefer to\ \ pass your timezone in date-time format for accurate result.For example:\ \ **2017-06-01T12:30:00+02:00**\n" recipients: $ref: "#/definitions/createWhatsAppCampaign_recipients" getWhatsAppConfig: type: "object" properties: whatsappBusinessAccountId: type: "string" example: "105569359072383" description: "Id of the WhatsApp business account" sendingLimit: type: "string" example: "TIER_1K" description: "Sending limit Information of the WhatsApp API account" phoneNumberQuality: type: "string" example: "GREEN" description: "Quality status of phone number associated with WhatsApp account.\ \ There are three quality ratings. example - **High (GREEN) , Medium (YELLOW)\ \ and Low(RED)**" enum: - "GREEN" - "YELLOW" - "RED" whatsappBusinessAccountStatus: type: "string" example: "APPROVED" description: "Status information related to WhatsApp Api account" businessStatus: type: "string" example: "verified" description: "Verification status information of the Business account" phoneNumberNameStatus: type: "string" example: "APPROVED" description: "Status of the name associated with WhatsApp Phone number" enum: - "APPROVED" - "PENDING" - "REJECTED" createWhatsAppTemplate: type: "object" required: - "body" - "category" - "language" - "name" properties: name: type: "string" example: "Test template" description: "Name of the template" language: type: "string" example: "en" description: "Language of the template" category: type: "string" example: "MARKETING" description: "Category of the template" enum: - "MARKETING" - "TRANSACTIONAL" mediaUrl: type: "string" example: "https://attachment.domain.com" description: "Absolute url of the media file **(no local file)**" body: type: "string" example: "making it look like readable English" description: "Body of the template" headerHtml: type: "string" example: "

gfhgfhv ghgjhLASTNAME

\"" description: "Html content of the header" headerType: type: "boolean" example: true createModel: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 122 description: "ID of the object created" example: id: 122 uploadImageModel: type: "object" required: - "url" properties: url: type: "string" format: "string" example: "https://img.mailinblue.com/100000/images/rnb/original/62casdase8wewq9df1c2f27c.jpeg" description: "URL of the image uploaded" example: url: "https://img.mailinblue.com/100000/images/rnb/original/62casdase8wewq9df1c2f27c.jpeg" createUpdateContactModel: properties: id: type: "integer" format: "int64" example: 122 description: "ID of the contact when a new contact is created" example: id: 122 updateBatchContactsModel: properties: successIds: type: "array" example: "1,2" items: type: "integer" format: "int64" description: "IDs which are successfully updated" failureIds: type: "array" example: "3,4" items: type: "integer" format: "int64" description: "IDs which are not updated" createSenderModel: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 5 description: "ID of the Sender created" spfError: type: "boolean" example: true description: "Status of SPF configuration for the sender (true = SPF not well\ \ configured, false = SPF well configured)" dkimError: type: "boolean" example: false description: "Status of DKIM configuration for the sender (true = DKIM not\ \ well configured, false = DKIM well configured)" example: dkimError: false id: 5 spfError: true createDomainModel: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 5 description: "ID of the Domain created" domain_name: type: "string" example: "true" description: "Domain" message: type: "string" example: "Domain added successfully. To authenticate it, add following DNS\ \ records" description: "Success message" dns_records: $ref: "#/definitions/createDomainModel_dns_records" example: domain_name: "true" dns_records: dkim_record: type: "type" value: "value" host_name: "host_name" status: true brevo_code: type: "type" value: "value" host_name: "host_name" status: true id: 5 message: "Domain added successfully. To authenticate it, add following DNS records" authenticateDomainModel: type: "object" required: - "domain_name" - "message" properties: domain_name: type: "string" example: "myexample.com" description: "Domain" message: type: "string" example: "Domain has been authenticated successfully." description: "Success message" example: domain_name: "myexample.com" message: "Domain has been authenticated successfully." getDomainonfigurationModel: type: "object" required: - "authenticated" - "dns_records" - "domain" - "verified" properties: domain: type: "string" example: "myexample.com" description: "Domain" verified: type: "boolean" example: true description: "Status of domain verification (true=verified, false=non verified)" authenticated: type: "boolean" example: false description: "Status of domain authentication (true=authenticated, false=non\ \ authenticated)" dns_records: $ref: "#/definitions/createDomainModel_dns_records" example: authenticated: false dns_records: dkim_record: type: "type" value: "value" host_name: "host_name" status: true brevo_code: type: "type" value: "value" host_name: "host_name" status: true domain: "myexample.com" verified: true createSmtpEmail: type: "object" properties: messageId: type: "string" example: "<201798300811.5787683@relay.domain.com>" description: "Message ID of the transactional email sent" messageIds: type: "array" items: type: "string" example: "" description: "version wise message ID's of the transactional emails sent" example: messageIds: - "" - "" messageId: "<201798300811.5787683@relay.domain.com>" scheduleSmtpEmail: type: "object" properties: messageId: type: "string" example: "<201798300811.5787683@relay.domain.com>" description: "Message ID of the transactional email scheduled" messageIds: type: "array" items: type: "string" description: "version wise message ID's of the transactional emails scheduled" batchId: type: "string" example: "5c6cfa04-eed9-42c2-8b5c-6d470d978e9d" description: "Batch ID of the batch transactional email scheduled" createReseller: type: "object" required: - "authKey" properties: authKey: type: "string" example: "xkeysib-21881axxxxxcc92e04-mIrexxxx7z" description: "AuthKey of Reseller child created" id: type: "integer" format: "int64" example: 1234567 description: "Id of Reseller child created" example: authKey: "xkeysib-21881axxxxxcc92e04-mIrexxxx7z" id: 1234567 sendSms: type: "object" required: - "messageId" - "reference" properties: reference: type: "string" example: "ab1cde2fgh3i4jklmno" messageId: type: "integer" format: "int64" example: 1511882900176220 smsCount: type: "integer" format: "int64" example: 2 description: "Count of SMS's to send multiple text messages" usedCredits: type: "number" format: "float" example: 0.7 description: "SMS credits used per text message" remainingCredits: type: "number" format: "float" example: 82.85 description: "Remaining SMS credits of the user" example: reference: "ab1cde2fgh3i4jklmno" remainingCredits: 82.85 smsCount: 2 messageId: 1511882900176220 usedCredits: 0.7 createdProcessId: type: "object" required: - "processId" properties: processId: type: "integer" format: "int64" example: 78 description: "Id of the process created" example: processId: 78 createUpdateFolder: type: "object" properties: name: type: "string" example: "Wordpress Contacts" description: "Name of the folder" postSendFailed: type: "object" required: - "code" - "message" properties: code: type: "integer" format: "int64" example: "invalid_parameter" description: "Response code" message: type: "string" example: "The email could not be sent to all recipients" description: "Response message" unexistingEmails: type: "array" items: type: "string" format: "email" example: "matthew.dow@example.com, elisa.carrely@example.com" description: "Email addresses you tried to sent an email to, but not existing\ \ in your contacts" withoutListEmails: type: "array" items: type: "string" format: "email" example: "jeff.dean@example.com, jim.sue@example.com" description: "Email addresses you sent an email to, without a contact list" blackListedEmails: type: "array" items: type: "string" format: "email" example: "jeff.dean@example.com, jim.sue@example.com" description: "Email addresses which are blacklisted. ONLY FOR email-campign's\ \ sendTest OR smtp-template's sendTest api's." postSendSmsTestFailed: type: "object" required: - "code" - "message" properties: code: type: "integer" format: "int64" example: "invalid_parameter" description: "Response code" message: type: "string" example: "The SMS could not be sent to all recipients" description: "Response message" unexistingSms: type: "array" items: type: "string" format: "email" example: "337699086644@mailin.com, 41778899954@mailin.com" description: "Email addresses you tried to sent a SMS to, but not existing\ \ in your contacts" withoutListSms: type: "array" items: type: "string" format: "email" example: "3542388988@mailin.com, 10976444477@mailin.com" description: "Email addresses you sent a SMS to, without a contact list" postContactInfo: type: "object" required: - "contacts" properties: contacts: $ref: "#/definitions/postContactInfo_contacts" example: contacts: total: 27 processId: 78 success: - "jeff32@example.com, jim56@example.com" - "jeff32@example.com, jim56@example.com" failure: - "jeff32@example.com, jim56@example.com" - "jeff32@example.com, jim56@example.com" getAggregatedReport: type: "object" properties: range: type: "string" example: "2016-09-08|2017-04-06" description: "Time frame of the report" requests: type: "integer" format: "int64" example: 263 description: "Number of requests for the timeframe" delivered: type: "integer" format: "int64" example: 249 description: "Number of delivered emails for the timeframe" hardBounces: type: "integer" format: "int64" example: 1 description: "Number of hardbounces for the timeframe" softBounces: type: "integer" format: "int64" example: 4 description: "Number of softbounces for the timeframe" clicks: type: "integer" format: "int64" example: 12 description: "Number of clicks for the timeframe" uniqueClicks: type: "integer" format: "int64" example: 8 description: "Number of unique clicks for the timeframe" opens: type: "integer" format: "int64" example: 47 description: "Number of openings for the timeframe" uniqueOpens: type: "integer" format: "int64" example: 37 description: "Number of unique openings for the timeframe" spamReports: type: "integer" format: "int64" example: 0 description: "Number of complaint (spam report) for the timeframe" blocked: type: "integer" format: "int64" example: 2 description: "Number of blocked contact emails for the timeframe" invalid: type: "integer" format: "int64" example: 0 description: "Number of invalid emails for the timeframe" unsubscribed: type: "integer" format: "int64" example: 0 description: "Number of unsubscribed emails for the timeframe" getTransacBlockedContacts: type: "object" properties: count: type: "integer" format: "int64" example: 1 description: "Count of blocked or unsubscribed contact" contacts: type: "array" items: $ref: "#/definitions/getTransacBlockedContacts_contacts" getReports: type: "object" properties: reports: type: "array" items: $ref: "#/definitions/getReports_reports" getEmailEventReport: type: "object" properties: events: type: "array" items: $ref: "#/definitions/getEmailEventReport_events" getSmsEventReport: type: "object" properties: events: type: "array" items: $ref: "#/definitions/getSmsEventReport_events" getSmtpTemplateOverview: type: "object" required: - "createdAt" - "htmlContent" - "id" - "isActive" - "modifiedAt" - "name" - "replyTo" - "sender" - "subject" - "tag" - "testSent" - "toField" properties: id: type: "integer" format: "int64" example: 4 description: "ID of the template" name: type: "string" example: "Order Confirmation - EN" description: "Name of the template" subject: type: "string" example: "Thanks for your order !" description: "Subject of the template" isActive: type: "boolean" example: true description: "Status of template (true=active, false=inactive)" testSent: type: "boolean" example: true description: "Status of test sending for the template (true=test email has\ \ been sent, false=test email has not been sent)" sender: $ref: "#/definitions/getSmtpTemplateOverview_sender" replyTo: type: "string" format: "email" example: "replyto@domain.com" description: "Email defined as the \"Reply to\" for the template" toField: type: "string" example: "{FIRSTNAME} {LASTNAME}" description: "Customisation of the \"to\" field for the template" tag: type: "string" example: "sports" description: "Tag of the template" htmlContent: type: "string" example: "Your order n°xxxxx has been confirmed. Thanks for your purchase." description: "HTML content of the template" createdAt: type: "string" example: "2017-05-01T12:30:00Z" description: "Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-12T12:30:00Z" description: "Last modification UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)" doiTemplate: type: "boolean" example: false description: "It is true if template is a valid Double opt-in (DOI) template,\ \ otherwise it is false. This field will be available only in case of single\ \ template detail call." getSmtpTemplates: type: "object" properties: count: type: "integer" format: "int64" example: 1 description: "Count of transactional email templates" templates: type: "array" items: $ref: "#/definitions/getSmtpTemplateOverview" getWebhook: type: "object" required: - "createdAt" - "description" - "events" - "id" - "modifiedAt" - "type" - "url" properties: url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the webhook" id: type: "integer" format: "int64" example: 654 description: "ID of the webhook" description: type: "string" example: "Webhook triggered on campaign openings" description: "Description of the webhook" events: type: "array" items: type: "string" example: "opens,clicks" description: "Events which will trigger the webhook when they occure" type: type: "string" example: "marketing" description: "Type of webhook (marketing or transactional)" enum: - "marketing" - "transactional" createdAt: type: "string" example: "2016-12-01T12:50:00Z" description: "Creation UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-12T13:15:00Z" description: "Last modification UTC date-time of the webhook (YYYY-MM-DDTHH:mm:ss.SSSZ)" getWebhooks: type: "object" required: - "webhooks" properties: webhooks: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getWebhook" getContactDetails: type: "object" required: - "attributes" - "createdAt" - "email" - "emailBlacklisted" - "id" - "listIds" - "modifiedAt" - "smsBlacklisted" properties: email: type: "string" format: "email" example: "john.smith@example.com" description: "Email address of the contact for which you requested the details" id: type: "integer" format: "int64" example: 32 description: "ID of the contact for which you requested the details" emailBlacklisted: type: "boolean" example: false description: "Blacklist status for email campaigns (true=blacklisted, false=not\ \ blacklisted)" smsBlacklisted: type: "boolean" example: true description: "Blacklist status for SMS campaigns (true=blacklisted, false=not\ \ blacklisted)" createdAt: type: "string" example: "2017-05-12T12:30:00Z" description: "Creation UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-12T12:30:00Z" description: "Last modification UTC date-time of the contact (YYYY-MM-DDTHH:mm:ss.SSSZ)" listIds: type: "array" items: type: "integer" format: "int64" example: "12,9,20" description: "List(s) in which the contact is included" listUnsubscribed: type: "array" items: type: "integer" format: "int64" example: "1,2" description: "List(s) in which the contact is included (only available if\ \ unsubscription per list is activated for the account)" attributes: type: "object" example: name: "Joe" email: "joe@example.com" description: "Set of attributes of the contact" properties: {} getExtendedContactDetails: allOf: - $ref: "#/definitions/getContactDetails" - type: "object" required: - "statistics" properties: statistics: $ref: "#/definitions/getExtendedContactDetails_statistics" getContactCampaignStats: type: "object" properties: messagesSent: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" hardBounces: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" softBounces: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" complaints: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" unsubscriptions: $ref: "#/definitions/getContactCampaignStats_unsubscriptions" opened: type: "array" items: $ref: "#/definitions/getContactCampaignStats_opened" clicked: type: "array" items: $ref: "#/definitions/getContactCampaignStats_clicked" transacAttributes: type: "array" items: $ref: "#/definitions/getContactCampaignStats_transacAttributes" delivered: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" description: "Campaign Statistics for the contact" getContacts: type: "object" required: - "contacts" - "count" properties: contacts: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getContactDetails" count: type: "integer" format: "int64" example: 17655 description: "Number of contacts" getAttributes: type: "object" required: - "attributes" properties: attributes: type: "array" description: "Listing of available contact attributes in your account" items: $ref: "#/definitions/getAttributes_attributes" getFolders: type: "object" properties: folders: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getFolder" count: type: "integer" format: "int64" example: 10 description: "Number of folders available in your account" getSegments: type: "object" properties: segments: $ref: "#/definitions/getSegments_segments" count: type: "integer" format: "int64" example: 10 description: "Number of Segments available in your account" getFolder: type: "object" required: - "id" - "name" - "totalBlacklisted" - "totalSubscribers" - "uniqueSubscribers" properties: id: type: "integer" format: "int64" example: 2 description: "ID of the folder" name: type: "string" example: "Magento Customers" description: "Name of the folder" totalBlacklisted: type: "integer" format: "int64" example: 32 description: "Number of blacklisted contacts in the folder" totalSubscribers: type: "integer" format: "int64" example: 19777 description: "Number of contacts in the folder" uniqueSubscribers: type: "integer" format: "int64" example: 16222 description: "Number of unique contacts in the folder" getFolderLists: type: "object" properties: lists: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getList" count: type: "integer" format: "int64" example: 6 description: "Number of lists in the folder" getLists: type: "object" properties: lists: type: "array" description: "Listing of all the lists available in your account" items: type: "object" allOf: - $ref: "#/definitions/getList" - type: "object" properties: folderId: type: "integer" format: "int64" example: 2 description: "ID of the folder" required: - "folderId" count: type: "integer" format: "int64" example: 150 description: "Number of lists in your account" getList: type: "object" required: - "id" - "name" - "totalBlacklisted" - "totalSubscribers" - "uniqueSubscribers" properties: id: type: "integer" format: "int64" example: 23 description: "ID of the list" name: type: "string" example: "Magento Customers - EN" description: "Name of the list" totalBlacklisted: type: "integer" format: "int64" example: 13 description: "Number of blacklisted contacts in the list" totalSubscribers: type: "integer" format: "int64" example: 1776 description: "Number of contacts in the list" uniqueSubscribers: type: "integer" format: "int64" example: 1789 description: "Number of unique contacts in the list" getExtendedList: allOf: - $ref: "#/definitions/getList" - type: "object" required: - "createdAt" - "folderId" properties: folderId: type: "integer" format: "int64" example: 2 description: "ID of the folder" createdAt: type: "string" example: "2017-03-13T17:05:09Z" description: "Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ)" campaignStats: type: "array" items: $ref: "#/definitions/getExtendedList_campaignStats" dynamicList: type: "boolean" example: false description: "Status telling if the list is dynamic or not (true=dynamic,\ \ false=not dynamic)" getSmsCampaignStats: type: "object" required: - "answered" - "delivered" - "hardBounces" - "processing" - "sent" - "softBounces" - "unsubscriptions" properties: delivered: type: "integer" format: "int64" example: 2987 description: "Number of delivered SMS" sent: type: "integer" format: "int64" example: 3000 description: "Number of sent SMS" processing: type: "integer" format: "int64" example: 0 description: "Number of processing SMS" softBounces: type: "integer" format: "int64" example: 3 description: "Number of softbounced SMS" hardBounces: type: "integer" format: "int64" example: 1 description: "Number of hardbounced SMS" unsubscriptions: type: "integer" format: "int64" example: 3 description: "Number of unsubscription SMS" answered: type: "integer" format: "int64" example: 2 description: "Number of replies to the SMS" getDeviceBrowserStats: type: "object" required: - "clickers" - "uniqueClicks" - "uniqueViews" - "viewed" properties: clickers: type: "integer" format: "int64" example: 2665 description: "Number of total clicks for the campaign using the particular\ \ browser" uniqueClicks: type: "integer" format: "int64" example: 2300 description: "Number of unique clicks for the campaign using the particular\ \ browser" viewed: type: "integer" format: "int64" example: 8999 description: "Number of openings for the campaign using the particular browser" uniqueViews: type: "integer" format: "int64" example: 7779 description: "Number of unique openings for the campaign using the particular\ \ browser" getCampaignStats: type: "object" required: - "clickers" - "complaints" - "delivered" - "hardBounces" - "sent" - "softBounces" - "trackableViews" - "uniqueClicks" - "uniqueViews" - "unsubscriptions" - "viewed" properties: listId: type: "integer" format: "int64" example: 2 description: "List Id of email campaign (only in case of get email campaign(s)(not\ \ for global stats))" uniqueClicks: type: "integer" format: "int64" example: 2300 description: "Number of unique clicks for the campaign" clickers: type: "integer" format: "int64" example: 2665 description: "Number of total clicks for the campaign" complaints: type: "integer" format: "int64" example: 1 description: "Number of complaints (Spam reports) for the campaign" delivered: type: "integer" format: "int64" example: 19765 description: "Number of delivered emails for the campaign" sent: type: "integer" format: "int64" example: 19887 description: "Number of sent emails for the campaign" softBounces: type: "integer" format: "int64" example: 100 description: "Number of softbounce for the campaign" hardBounces: type: "integer" format: "int64" example: 87 description: "Number of harbounce for the campaign" uniqueViews: type: "integer" format: "int64" example: 7779 description: "Number of unique openings for the campaign" trackableViews: type: "integer" format: "int64" example: 5661 description: "Recipients without any privacy protection option enabled in\ \ their email client" trackableViewsRate: type: "number" format: "float" example: 23.45 description: "Rate of recipients without any privacy protection option enabled\ \ in their email client" estimatedViews: type: "integer" format: "int64" example: 560 description: "Rate of recipients without any privacy protection option enabled\ \ in their email client, applied to all delivered emails" unsubscriptions: type: "integer" format: "int64" example: 2 description: "Number of unsubscription for the campaign" viewed: type: "integer" format: "int64" example: 8999 description: "Number of openings for the campaign" deferred: type: "integer" format: "int64" example: 30 description: "Number of deferred emails for the campaign" returnBounce: type: "integer" format: "int64" example: 5 description: "Total number of non-delivered campaigns for a particular campaign\ \ id." updateSmtpTemplate: type: "object" properties: tag: type: "string" example: "OrderConfirmation" description: "Tag of the template" sender: $ref: "#/definitions/updateSmtpTemplate_sender" templateName: type: "string" example: "Order Confirmation - EN" description: "Name of the template" htmlContent: type: "string" example: "The order n°xxxxx has been confirmed. Thanks for your purchase" description: "Required if htmlUrl is empty. If the template is designed using\ \ Drag & Drop editor via HTML content, then the design page will not have\ \ Drag & Drop editor access for that template. Body of the message (HTML\ \ must have more than 10 characters)" htmlUrl: type: "string" format: "url" example: "https://html.domain.com" description: "Required if htmlContent is empty. URL to the body of the email\ \ (HTML)" subject: type: "string" example: "Thanks for your purchase !" description: "Subject of the email" replyTo: type: "string" format: "email" example: "support@myshop.com" description: "Email on which campaign recipients will be able to reply to" toField: type: "string" example: "{FNAME} {LNAME}" description: "To personalize the «To» Field. If you want to include the first\ \ name and last name of your recipient, add {FNAME} {LNAME}. These contact\ \ attributes must already exist in your Brevo account. If input parameter\ \ 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization" attachmentUrl: type: "string" format: "url" example: "https://attachment.domain.com" description: "Absolute url of the attachment (no local file). Extension allowed:\ \ xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif,\ \ tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar,\ \ ez, ics, mobi, msg, pub and eps" isActive: type: "boolean" example: true description: "Status of the template. isActive = false means template is inactive,\ \ isActive = true means template is active" updateCampaignStatus: type: "object" properties: status: type: "string" description: "Note:- replicateTemplate status will be available only for template\ \ type campaigns." enum: - "suspended" - "archive" - "darchive" - "sent" - "queued" - "replicate" - "replicateTemplate" - "draft" description: "Status of the campaign" example: "draft" createSmtpTemplate: type: "object" required: - "sender" - "subject" - "templateName" properties: tag: type: "string" example: "OrderConfirmation" description: "Tag of the template" sender: $ref: "#/definitions/createSmtpTemplate_sender" templateName: type: "string" example: "Order Confirmation - EN" description: "Name of the template" htmlContent: type: "string" example: "The order n°xxxxx has been confirmed. Thanks for your purchase" description: "Body of the message (HTML version). The field must have more\ \ than 10 characters. REQUIRED if htmlUrl is empty" htmlUrl: type: "string" format: "url" example: "https://html.domain.com" description: "Url which contents the body of the email message. REQUIRED if\ \ htmlContent is empty" subject: type: "string" example: "Thanks for your purchase !" description: "Subject of the template" replyTo: type: "string" format: "email" example: "support@myshop.com" description: "Email on which campaign recipients will be able to reply to" toField: type: "string" example: "{FNAME} {LNAME}" description: "To personalize the «To» Field. If you want to include the first\ \ name and last name of your recipient, add {FNAME} {LNAME}. These contact\ \ attributes must already exist in your Brevo account. If input parameter\ \ 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization" attachmentUrl: type: "string" format: "url" example: "https://attachment.domain.com" description: "Absolute url of the attachment (no local file). Extension allowed:\ \ xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif,\ \ tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar,\ \ ez, ics, mobi, msg, pub and eps" isActive: type: "boolean" example: true description: "Status of template. isActive = true means template is active\ \ and isActive = false means template is inactive" createEmailCampaign: type: "object" required: - "name" - "sender" properties: tag: type: "string" example: "Newsletter" description: "Tag of the campaign" sender: $ref: "#/definitions/createEmailCampaign_sender" name: type: "string" example: "Newsletter - May 2017" description: "Name of the campaign" htmlContent: type: "string" example: "

Confirm you email

Please\ \ confirm your email address by clicking on the link below

" description: "Mandatory if htmlUrl and templateId are empty. Body of the message\ \ (HTML)" htmlUrl: type: "string" format: "url" example: "https://html.domain.com" description: "Mandatory if htmlContent and templateId are empty. Url to the\ \ message (HTML)" templateId: type: "integer" format: "int64" description: "Mandatory if htmlContent and htmlUrl are empty. Id of the transactional\ \ email template with status 'active'. Used to copy only its content fetched\ \ from htmlContent/htmlUrl to an email campaign for RSS feature." scheduledAt: type: "string" example: "2017-06-01T12:30:00+02:00" description: "Sending UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ). Prefer to\ \ pass your timezone in date-time format for accurate result. If sendAtBestTime\ \ is set to true, your campaign will be sent according to the date passed\ \ (ignoring the time part)." subject: type: "string" example: "Discover the New Collection !" description: "Subject of the campaign. Mandatory if abTesting is false. Ignored\ \ if abTesting is true." replyTo: type: "string" format: "email" example: "support@myshop.com" description: "Email on which the campaign recipients will be able to reply\ \ to" toField: type: "string" example: "{FNAME} {LNAME}" description: "To personalize the «To» Field. If you want to include the first\ \ name and last name of your recipient, add {FNAME} {LNAME}. These contact\ \ attributes must already exist in your Brevo account. If input parameter\ \ 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization" recipients: $ref: "#/definitions/createEmailCampaign_recipients" attachmentUrl: type: "string" format: "url" example: "https://attachment.domain.com" description: "Absolute url of the attachment (no local file). Extension allowed:\ \ xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif,\ \ tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar,\ \ ez, ics, mobi, msg, pub and eps" inlineImageActivation: type: "boolean" example: true description: "Use true to embedded the images in your email. Final size of\ \ the email should be less than 4MB. Campaigns with embedded images can\ \ not be sent to more than 5000 contacts" default: false mirrorActive: type: "boolean" example: true description: "Use true to enable the mirror link" footer: type: "string" example: "[DEFAULT_FOOTER]" description: "Footer of the email campaign" header: type: "string" example: "[DEFAULT_HEADER]" description: "Header of the email campaign" utmCampaign: type: "string" example: "NL_05_2017" description: "Customize the utm_campaign value. If this field is empty, the\ \ campaign name will be used. Only alphanumeric characters and spaces are\ \ allowed" params: type: "object" example: FNAME: "Joe" LNAME: "Doe" description: "Pass the set of attributes to customize the type classic campaign.\ \ For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. Only available if\ \ 'type' is 'classic'. It's considered only if campaign is in New Template\ \ Language format. The New Template Language is dependent on the values\ \ of 'subject', 'htmlContent/htmlUrl', 'sender.name' & 'toField'" properties: {} sendAtBestTime: type: "boolean" example: true description: "Set this to true if you want to send your campaign at best time." default: false abTesting: type: "boolean" example: true description: "Status of A/B Test. abTesting = false means it is disabled,\ \ & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule',\ \ 'winnerCriteria' & 'winnerDelay' will be considered when abTesting is\ \ set to true. 'subjectA' & 'subjectB' are mandatory together & 'subject'\ \ if passed is ignored. Can be set to true only if 'sendAtBestTime' is 'false'.\ \ You will be able to set up two subject lines for your campaign and send\ \ them to a random sample of your total recipients. Half of the test group\ \ will receive version A, and the other half will receive version B" default: false subjectA: type: "string" example: "Discover the New Collection!" description: "Subject A of the campaign. Mandatory if abTesting = true. subjectA\ \ & subjectB should have unique value" subjectB: type: "string" example: "Want to discover the New Collection?" description: "Subject B of the campaign. Mandatory if abTesting = true. subjectA\ \ & subjectB should have unique value" splitRule: type: "integer" format: "int64" example: 50 description: "Add the size of your test groups. Mandatory if abTesting = true\ \ & 'recipients' is passed. We'll send version A and B to a random sample\ \ of recipients, and then the winning version to everyone else" minimum: 1 maximum: 50 winnerCriteria: type: "string" example: "open" description: "Choose the metrics that will determinate the winning version.\ \ Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria'\ \ is ignored if passed" enum: - "open" - "click" winnerDelay: type: "integer" format: "int64" example: 50 description: "Choose the duration of the test in hours. Maximum is 7 days,\ \ pass 24*7 = 168 hours. The winning version will be sent at the end of\ \ the test. Mandatory if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerDelay'\ \ is ignored if passed" minimum: 1 maximum: 168 ipWarmupEnable: type: "boolean" example: true description: "Available for dedicated ip clients. Set this to true if you\ \ wish to warm up your ip." default: false initialQuota: type: "integer" format: "int64" example: 3000 description: "Mandatory if ipWarmupEnable is set to true. Set an initial quota\ \ greater than 1 for warming up your ip. We recommend you set a value of\ \ 3000." increaseRate: type: "integer" format: "int64" example: 70 description: "Mandatory if ipWarmupEnable is set to true. Set a percentage\ \ increase rate for warming up your ip. We recommend you set the increase\ \ rate to 30% per day. If you want to send the same number of emails every\ \ day, set the daily increase value to 0%." minimum: 0 maximum: 100 unsubscriptionPageId: type: "string" example: "62cbb7fabbe85021021aac52" description: "Enter an unsubscription page id. The page id is a 24 digit alphanumeric\ \ id that can be found in the URL when editing the page. If not entered,\ \ then the default unsubscription page will be used." updateFormId: type: "string" example: "6313436b9ad40e23b371d095" description: "Mandatory if templateId is used containing the {{ update_profile\ \ }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric\ \ id that can be found in the URL when editing the form. If not entered,\ \ then the default update profile form will be used." updateEmailCampaign: type: "object" properties: tag: type: "string" example: "Newsletter" description: "Tag of the campaign" sender: $ref: "#/definitions/updateEmailCampaign_sender" name: type: "string" example: "Newsletter - May 2017" description: "Name of the campaign" htmlContent: type: "string" example: "

Confirm you email

Please\ \ confirm your email address by clicking on the link below

" description: "Body of the message (HTML version). If the campaign is designed\ \ using Drag & Drop editor via HTML content, then the design page will not\ \ have Drag & Drop editor access for that campaign. REQUIRED if htmlUrl\ \ is empty" htmlUrl: type: "string" format: "url" example: "https://html.domain.com" description: "Url which contents the body of the email message. REQUIRED if\ \ htmlContent is empty" scheduledAt: type: "string" example: "2017-06-01T12:30:00+02:00" description: "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ).\ \ Prefer to pass your timezone in date-time format for accurate result.\ \ If sendAtBestTime is set to true, your campaign will be sent according\ \ to the date passed (ignoring the time part)." subject: type: "string" example: "Discover the New Collection !" description: "Subject of the campaign" replyTo: type: "string" format: "email" example: "support@myshop.com" description: "Email on which campaign recipients will be able to reply to" toField: type: "string" example: "{FNAME} {LNAME}" description: "To personalize the «To» Field. If you want to include the first\ \ name and last name of your recipient, add {FNAME} {LNAME}. These contact\ \ attributes must already exist in your Brevo account. If input parameter\ \ 'params' used please use {{contact.FNAME}} {{contact.LNAME}} for personalization" recipients: $ref: "#/definitions/updateEmailCampaign_recipients" attachmentUrl: type: "string" format: "url" example: "https://attachment.domain.com" description: "Absolute url of the attachment (no local file). Extension allowed:\ \ xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg, png, tif,\ \ tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx, tar,\ \ ez, ics, mobi, msg, pub and eps" inlineImageActivation: type: "boolean" example: true description: "Status of inline image. inlineImageActivation = false means\ \ image can’t be embedded, & inlineImageActivation = true means image can\ \ be embedded, in the email. You cannot send a campaign of more than 4MB\ \ with images embedded in the email. Campaigns with the images embedded\ \ in the email must be sent to less than 5000 contacts." default: false mirrorActive: type: "boolean" example: true description: "Status of mirror links in campaign. mirrorActive = false means\ \ mirror links are deactivated, & mirrorActive = true means mirror links\ \ are activated, in the campaign" recurring: type: "boolean" example: false description: "FOR TRIGGER ONLY ! Type of trigger campaign.recurring = false\ \ means contact can receive the same Trigger campaign only once, & recurring\ \ = true means contact can receive the same Trigger campaign several times" default: false footer: type: "string" example: "[DEFAULT_FOOTER]" description: "Footer of the email campaign" header: type: "string" example: "[DEFAULT_HEADER]" description: "Header of the email campaign" utmCampaign: type: "string" example: "NL_05_2017" description: "Customize the utm_campaign value. If this field is empty, the\ \ campaign name will be used. Only alphanumeric characters and spaces are\ \ allowed" params: type: "object" example: FNAME: "Joe" LNAME: "Doe" description: "Pass the set of attributes to customize the type 'classic' campaign.\ \ For example, {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. The 'params' field\ \ will get updated, only if the campaign is in New Template Language, else\ \ ignored. The New Template Language is dependent on the values of 'subject',\ \ 'htmlContent/htmlUrl', 'sender.name' & 'toField'" properties: {} sendAtBestTime: type: "boolean" example: true description: "Set this to true if you want to send your campaign at best time.\ \ Note:- if true, warmup ip will be disabled." abTesting: type: "boolean" example: true description: "Status of A/B Test. abTesting = false means it is disabled,\ \ & abTesting = true means it is enabled. 'subjectA', 'subjectB', 'splitRule',\ \ 'winnerCriteria' & 'winnerDelay' will be considered if abTesting is set\ \ to true. 'subject' if passed is ignored. Can be set to true only if 'sendAtBestTime'\ \ is 'false'. You will be able to set up two subject lines for your campaign\ \ and send them to a random sample of your total recipients. Half of the\ \ test group will receive version A, and the other half will receive version\ \ B" default: false subjectA: type: "string" example: "Discover the New Collection!" description: "Subject A of the campaign. Considered if abTesting = true. subjectA\ \ & subjectB should have unique value" subjectB: type: "string" example: "Want to discover the New Collection?" description: "Subject B of the campaign. Considered if abTesting = true. subjectA\ \ & subjectB should have unique value" splitRule: type: "integer" format: "int64" example: 50 description: "Add the size of your test groups. Considered if abTesting =\ \ true. We'll send version A and B to a random sample of recipients, and\ \ then the winning version to everyone else" minimum: 1 maximum: 50 winnerCriteria: type: "string" example: "open" description: "Choose the metrics that will determinate the winning version.\ \ Considered if 'splitRule' >= 1 and < 50. If splitRule = 50, 'winnerCriteria'\ \ is ignored if passed or alreday exist in record" enum: - "open" - "click" winnerDelay: type: "integer" format: "int64" example: 50 description: "Choose the duration of the test in hours. Maximum is 7 days,\ \ pass 24*7 = 168 hours. The winning version will be sent at the end of\ \ the test. Considered if 'splitRule' >= 1 and < 50. If splitRule = 50,\ \ 'winnerDelay' is ignored if passed or alreday exist in record" minimum: 1 maximum: 168 ipWarmupEnable: type: "boolean" example: true description: "Available for dedicated ip clients. Set this to true if you\ \ wish to warm up your ip." default: false initialQuota: type: "integer" format: "int64" example: 3000 description: "Set an initial quota greater than 1 for warming up your ip.\ \ We recommend you set a value of 3000." increaseRate: type: "integer" format: "int64" example: 70 description: "Set a percentage increase rate for warming up your ip. We recommend\ \ you set the increase rate to 30% per day. If you want to send the same\ \ number of emails every day, set the daily increase value to 0%." minimum: 0 maximum: 100 unsubscriptionPageId: type: "string" example: "62cbb7fabbe85021021aac52" description: "Enter an unsubscription page id. The page id is a 24 digit alphanumeric\ \ id that can be found in the URL when editing the page." updateFormId: type: "string" example: "6313436b9ad40e23b371d095" description: "Mandatory if templateId is used containing the {{ update_profile\ \ }} tag. Enter an update profile form id. The form id is a 24 digit alphanumeric\ \ id that can be found in the URL when editing the form." getSharedTemplateUrl: type: "object" required: - "sharedUrl" properties: sharedUrl: type: "string" format: "url" example: "https://my.brevo.com/pt2YU7R5W_guXlowgumy_VX4pFsKu._zd0Gjj96x1_GMmzc1Qps5ZIpj6nx-" description: "A unique URL for the email campaign or transactional template.\ \ This URL can be shared with other Brevo users." abTestCampaignResult: type: "object" properties: winningVersion: type: "string" example: "A" description: "Winning Campaign Info. pending = Campaign has been picked for\ \ sending and winning version is yet to be decided, tie = A tie happened\ \ between both the versions, notAvailable = Campaign has not yet been picked\ \ for sending." enum: - "notAvailable" - "pending" - "tie" - "A" - "B" winningCriteria: type: "string" example: "Open" description: "Criteria choosen for winning version (Open/Click)" enum: - "Open" - "Click" winningSubjectLine: type: "string" example: "Subject Line A" description: "Subject Line of current winning version" openRate: type: "string" example: "70%" description: "Open rate for current winning version" clickRate: type: "string" example: "70%" description: "Click rate for current winning version" winningVersionRate: type: "string" example: "70%" description: "Open/Click rate for the winner version" statistics: $ref: "#/definitions/abTestCampaignResult_statistics" clickedLinks: $ref: "#/definitions/abTestCampaignResult_clickedLinks" emailExportRecipients: type: "object" required: - "recipientsType" properties: notifyURL: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "Webhook called once the export process is finished. For reference,\ \ https://help.brevo.com/hc/en-us/articles/360007666479" recipientsType: type: "string" example: "openers" description: "Type of recipients to export for a campaign" enum: - "all" - "nonClickers" - "nonOpeners" - "clickers" - "openers" - "softBounces" - "hardBounces" - "unsubscribed" requestSmsRecipientExport: type: "object" required: - "recipientsType" properties: notifyURL: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL that will be called once the export process is finished.\ \ For reference, https://help.brevo.com/hc/en-us/articles/360007666479" recipientsType: type: "string" example: "answered" description: "Filter the recipients based on how they interacted with the\ \ campaign" enum: - "all" - "delivered" - "answered" - "softBounces" - "hardBounces" - "unsubscribed" sendReport: type: "object" required: - "email" properties: language: type: "string" example: "en" description: "Language of email content for campaign report sending." enum: - "fr" - "es" - "pt" - "it" - "de" - "en" default: "fr" email: $ref: "#/definitions/sendReport_email" uploadImageToGallery: type: "object" required: - "imageUrl" properties: imageUrl: type: "string" example: "https://somedomain.com/image1.jpg" description: "The absolute url of the image (no local file). Maximum allowed\ \ size for image is 2MB. Allowed extensions for images are - jpeg, jpg,\ \ png, bmp, gif." name: type: "string" example: "nature.jpg" description: "Name of the image." sendSmtpEmail: type: "object" properties: sender: $ref: "#/definitions/sendSmtpEmail_sender" to: type: "array" description: "Mandatory if messageVersions are not passed, ignored if messageVersions\ \ are passed. List of email addresses and names (optional) of the recipients.\ \ For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"},\ \ {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]" items: $ref: "#/definitions/sendSmtpEmail_to" bcc: type: "array" description: "List of email addresses and names (optional) of the recipients\ \ in bcc" items: $ref: "#/definitions/sendSmtpEmail_bcc" cc: type: "array" description: "List of email addresses and names (optional) of the recipients\ \ in cc" items: $ref: "#/definitions/sendSmtpEmail_cc" htmlContent: type: "string" example: "

Confirm you email

Please\ \ confirm your email address by clicking on the link below

" description: "HTML body of the message ( Mandatory if 'templateId' is not\ \ passed, ignored if 'templateId' is passed )" textContent: type: "string" example: "Please confirm your email address by clicking on the link https://text.domain.com" description: "Plain Text body of the message ( Ignored if 'templateId' is\ \ passed )" subject: type: "string" example: "Login Email confirmation" description: "Subject of the message. Mandatory if 'templateId' is not passed" replyTo: $ref: "#/definitions/sendSmtpEmail_replyTo" attachment: type: "array" description: "Pass the absolute URL (no local file) or the base64 content\ \ of the attachment along with the attachment name (Mandatory if attachment\ \ content is passed). For example, `[{\"url\":\"https://attachment.domain.com/myAttachmentFromUrl.jpg\"\ , \"name\":\"myAttachmentFromUrl.jpg\"}, {\"content\":\"base64 example content\"\ , \"name\":\"myAttachmentFromBase64.jpg\"}]`. Allowed extensions for attachment\ \ file: xlsx, xls, ods, docx, docm, doc, csv, pdf, txt, gif, jpg, jpeg,\ \ png, tif, tiff, rtf, bmp, cgm, css, shtml, html, htm, zip, xml, ppt, pptx,\ \ tar, ez, ics, mobi, msg, pub, eps, odt, mp3, m4a, m4v, wma, ogg, flac,\ \ wav, aif, aifc, aiff, mp4, mov, avi, mkv, mpeg, mpg, wmv, pkpass and xlsm\ \ ( If 'templateId' is passed and is in New Template Language format then\ \ both attachment url and content are accepted. If template is in Old template\ \ Language format, then 'attachment' is ignored )" items: $ref: "#/definitions/sendSmtpEmail_attachment" headers: type: "object" example: sender.ip: "1.2.3.4" X-Mailin-custom: "some_custom_header" idempotencyKey: "abc-123" description: "Pass the set of custom headers (not the standard headers) that\ \ shall be sent along the mail headers in the original email. 'sender.ip'\ \ header can be set (only for dedicated ip users) to mention the IP to be\ \ used for sending transactional emails. Headers are allowed in `This-Case-Only`\ \ (i.e. words separated by hyphen with first letter of each word in capital\ \ letter), they will be converted to such case styling if not in this format\ \ in the request payload. For example, `{\"sender.ip\":\"1.2.3.4\", \"X-Mailin-custom\"\ :\"some_custom_header\", \"idempotencyKey\":\"abc-123\"}`." properties: {} templateId: type: "integer" format: "int64" example: 2 description: "Id of the template." params: type: "object" example: FNAME: "Joe" LNAME: "Doe" description: "Pass the set of attributes to customize the template. For example,\ \ {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template\ \ is in New Template Language format." properties: {} messageVersions: type: "array" description: "You can customize and send out multiple versions of a mail.\ \ templateId can be customized only if global parameter contains templateId.\ \ htmlContent and textContent can be customized only if any of the two,\ \ htmlContent or textContent, is present in global parameters. Some global\ \ parameters such as **to(mandatory), bcc, cc, replyTo, subject** can also\ \ be customized specific to each version. Total number of recipients in\ \ one API request must not exceed 2000. However, you can still pass upto\ \ 99 recipients maximum in one message version. The size of individual params\ \ in all the messageVersions shall not exceed 100 KB limit and that of cumulative\ \ params shall not exceed 1000 KB. You can follow this **step-by-step guide**\ \ on how to use **messageVersions** to batch send emails - https://developers.brevo.com/docs/batch-send-transactional-emails" items: $ref: "#/definitions/sendSmtpEmail_messageVersions" tags: type: "array" description: "Tag your emails to find them more easily" items: type: "string" example: "tag1" scheduledAt: type: "string" format: "date-time" example: "2022-04-05T12:30:00+02:00" description: "UTC date-time on which the email has to schedule (YYYY-MM-DDTHH:mm:ss.SSSZ).\ \ Prefer to pass your timezone in date-time format for scheduling. There\ \ can be an expected delay of +5 minutes in scheduled email delivery. **Please\ \ note this feature is currently a public beta**." batchId: type: "string" example: "5c6cfa04-eed9-42c2-8b5c-6d470d978e9d" description: "Valid UUIDv4 batch id to identify the scheduled batches transactional\ \ email. If not passed we will create a valid UUIDv4 batch id at our end." deleteHardbounces: type: "object" properties: startDate: type: "string" example: "2016-12-31" description: "Starting date (YYYY-MM-DD) of the time period for deletion.\ \ The hardbounces occurred after this date will be deleted. Must be less\ \ than or equal to the endDate" endDate: type: "string" example: "2017-01-31" description: "Ending date (YYYY-MM-DD) of the time period for deletion. The\ \ hardbounces until this date will be deleted. Must be greater than or equal\ \ to the startDate" contactEmail: type: "string" format: "email" example: "alex76@example.com" description: "Target a specific email address" createWebhook: type: "object" required: - "events" - "url" properties: url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the webhook" description: type: "string" example: "Webhook triggered on unsubscription" description: "Description of the webhook" events: type: "array" description: "- Events triggering the webhook. Possible values for **Transactional**\ \ type webhook:\n#### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`,\ \ `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened`\ \ and `unsubscribed`\n- Possible values for **Marketing** type webhook:\n\ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`,\ \ `listAddition` & `delivered`\n- Possible values for **Inbound** type webhook:\n\ #### `inboundEmailProcessed`\n" items: type: "string" example: "unsubscribed" enum: - "sent" - "hardBounce" - "softBounce" - "blocked" - "spam" - "delivered" - "request" - "click" - "invalid" - "deferred" - "opened" - "uniqueOpened" - "unsubscribed" - "listAddition" - "contactUpdated" - "contactDeleted" - "inboundEmailProcessed" type: type: "string" example: "marketing" description: "Type of the webhook" enum: - "transactional" - "marketing" - "inbound" default: "transactional" domain: type: "string" example: "example.com" description: "Inbound domain of webhook, required in case of event type `inbound`" updateWebhook: type: "object" properties: url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the webhook" description: type: "string" example: "Webhook triggered on contact hardbounce" description: "Description of the webhook" events: type: "array" description: "- Events triggering the webhook. Possible values for **Transactional**\ \ type webhook:\n#### `sent` OR `request`, `delivered`, `hardBounce`, `softBounce`,\ \ `blocked`, `spam`, `invalid`, `deferred`, `click`, `opened`, `uniqueOpened`\ \ and `unsubscribed`\n- Possible values for **Marketing** type webhook:\n\ #### `spam`, `opened`, `click`, `hardBounce`, `softBounce`, `unsubscribed`,\ \ `listAddition` & `delivered`\n- Possible values for **Inbound** type webhook:\n\ #### `inboundEmailProcessed`\n" items: type: "string" example: "hardBounce" enum: - "sent" - "hardBounce" - "softBounce" - "blocked" - "spam" - "delivered" - "request" - "click" - "invalid" - "deferred" - "opened" - "uniqueOpened" - "unsubscribed" - "listAddition" - "contactUpdated" - "contactDeleted" - "inboundEmailProcessed" domain: type: "string" example: "example.com" description: "Inbound domain of webhook, used in case of event type `inbound`" createDoiContact: type: "object" required: - "email" - "includeListIds" - "redirectionUrl" - "templateId" properties: email: type: "string" format: "email" example: "elly@example.com" description: "Email address where the confirmation email will be sent. This\ \ email address will be the identifier for all other contact attributes." attributes: type: "object" example: FNAME: "Elly" LNAME: "Roger" description: "Pass the set of attributes and their values. These attributes\ \ must be present in your Brevo account. For eg. {'FNAME':'Elly', 'LNAME':'Roger'}" properties: {} includeListIds: type: "array" description: "Lists under user account where contact should be added" items: type: "integer" format: "int64" example: 36 description: "Id of the list" excludeListIds: type: "array" description: "Lists under user account where contact should not be added" items: type: "integer" format: "int64" example: 36 description: "Id of the list" templateId: type: "integer" format: "int64" example: 2 description: "Id of the Double opt-in (DOI) template" redirectionUrl: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the web page that user will be redirected to after clicking\ \ on the double opt in URL. When editing your DOI template you can reference\ \ this URL by using the tag {{ params.DOIurl }}." createContact: type: "object" properties: email: type: "string" format: "email" example: "elly@example.com" description: "Email address of the user. Mandatory if \"SMS\" field is not\ \ passed in \"attributes\" parameter. Mobile Number in \"SMS\" field should\ \ be passed with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"\ } or {\"SMS\":\"0091xxxxxxxxxx\"}" ext_id: type: "string" example: "externalId" description: "Pass your own Id to create a contact." attributes: type: "object" example: FNAME: "Elly" LNAME: "Roger" description: "Pass the set of attributes and their values. The attribute's\ \ parameter should be passed in capital letter while creating a contact.\ \ These attributes must be present in your Brevo account. For eg. {\"FNAME\"\ :\"Elly\", \"LNAME\":\"Roger\"}" properties: {} emailBlacklisted: type: "boolean" example: false description: "Set this field to blacklist the contact for emails (emailBlacklisted\ \ = true)" smsBlacklisted: type: "boolean" example: false description: "Set this field to blacklist the contact for SMS (smsBlacklisted\ \ = true)" listIds: type: "array" description: "Ids of the lists to add the contact to" items: type: "integer" format: "int64" example: 36 description: "Id of the list to add the contact to" updateEnabled: type: "boolean" example: false description: "Facilitate to update the existing contact in the same request\ \ (updateEnabled = true)" default: false smtpBlacklistSender: type: "array" description: "transactional email forbidden sender for contact. Use only for\ \ email Contact ( only available if updateEnabled = true )" items: type: "string" format: "email" updateContact: type: "object" properties: attributes: type: "object" example: EMAIL: "newemail@domain.com" FNAME: "Ellie" LNAME: "Roger" description: "Pass the set of attributes to be updated. These attributes must\ \ be present in your account. To update existing email address of a contact\ \ with the new one please pass EMAIL in attributes. For example, `{ \"EMAIL\"\ :\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\":\"Roger\"}`. The\ \ attribute's parameter should be passed in capital letter while updating\ \ a contact. Keep in mind transactional attributes can be updated the same\ \ way as normal attributes. Mobile Number in \"SMS\" field should be passed\ \ with proper country code. For example {\"SMS\":\"+91xxxxxxxxxx\"} or {\"\ SMS\":\"0091xxxxxxxxxx\"}" properties: {} ext_id: type: "string" example: "updateExternalId" description: "Pass your own Id to update ext_id of a contact." emailBlacklisted: type: "boolean" example: false description: "Set/unset this field to blacklist/allow the contact for emails\ \ (emailBlacklisted = true)" smsBlacklisted: type: "boolean" example: true description: "Set/unset this field to blacklist/allow the contact for SMS\ \ (smsBlacklisted = true)" listIds: type: "array" description: "Ids of the lists to add the contact to" items: type: "integer" format: "int64" example: 65 description: "Id of the list to add the contact to" unlinkListIds: type: "array" description: "Ids of the lists to remove the contact from" items: type: "integer" format: "int64" example: 36 description: "Id of the list to remove the contact from" smtpBlacklistSender: type: "array" description: "transactional email forbidden sender for contact. Use only for\ \ email Contact" items: type: "string" format: "email" updateBatchContacts: type: "object" properties: contacts: type: "array" description: "List of contacts to be updated" items: $ref: "#/definitions/updateBatchContacts_contacts" createAttribute: type: "object" properties: value: type: "string" example: "COUNT[BLACKLISTED,BLACKLISTED,<,NOW()]" description: "Value of the attribute. Use only if the attribute's category\ \ is 'calculated' or 'global'" isRecurring: type: "boolean" example: true description: "Type of the attribute. Use only if the attribute's category\ \ is 'calculated' or 'global'" enumeration: type: "array" description: "List of values and labels that the attribute can take. Use only\ \ if the attribute's category is \"category\". For example, [{\"value\"\ :1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]" items: $ref: "#/definitions/createAttribute_enumeration" type: type: "string" example: "text" description: "Type of the attribute. Use only if the attribute's category\ \ is 'normal', 'category' or 'transactional' ( type 'boolean' is only available\ \ if the category is 'normal' attribute, type 'id' is only available if\ \ the category is 'transactional' attribute & type 'category' is only available\ \ if the category is 'category' attribute )" enum: - "text" - "date" - "float" - "boolean" - "id" - "category" updateAttribute: type: "object" properties: value: type: "string" example: "COUNT[BLACKLISTED,BLACKLISTED,<,NOW()]" description: "Value of the attribute to update. Use only if the attribute's\ \ category is 'calculated' or 'global'" enumeration: type: "array" description: "List of the values and labels that the attribute can take. Use\ \ only if the attribute's category is \"category\". For example, [{\"value\"\ :1, \"label\":\"male\"}, {\"value\":2, \"label\":\"female\"}]" items: $ref: "#/definitions/updateAttribute_enumeration" createList: type: "object" required: - "folderId" - "name" properties: name: type: "string" example: "Magento Customer - ES" description: "Name of the list" folderId: type: "integer" format: "int64" example: 2 description: "Id of the parent folder in which this list is to be created" ssoTokenRequest: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 2333323 description: "Id of the sub-account organization" email: type: "string" example: "vipin+subaccount@brevo.com" description: "User email of sub-account organization" target: type: "string" example: "contacts" description: "Set target after login success\n* automation - Redirect to Automation\ \ after login\n* email_campaign - Redirect to Email Campaign after login\n\ * contacts - Redirect to Contacts after login\n* landing_pages - Redirect\ \ to Landing Pages after login\n* email_transactional - Redirect to Email\ \ Transactional after login\n* senders - Redirect to Contacts after login\n\ * sms_campaign - Redirect to Sms Campaign after login\n* sms_transactional\ \ - Redirect to Sms Transactional after login\n" enum: - "automation" - "email_campaign" - "contacts" - "landing_pages" - "email_transactional" - "senders" - "sms_campaign" - "sms_transactional" createApiKeyRequest: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 2333323 description: "Id of the sub-account organization" name: type: "string" example: "My Api Key" description: "Name of the API key" updateList: type: "object" properties: name: type: "string" example: "Magento Customer - ES" description: "Name of the list. Either of the two parameters (name, folderId)\ \ can be updated at a time." folderId: type: "integer" format: "int64" example: 2 description: "Id of the folder in which the list is to be moved. Either of\ \ the two parameters (name, folderId) can be updated at a time." requestContactExport: type: "object" required: - "customContactFilter" properties: exportAttributes: type: "array" description: "List of all the attributes that you want to export. These attributes\ \ must be present in your contact database. For example, ['fname', 'lname',\ \ 'email']." items: type: "string" example: "NAME" customContactFilter: $ref: "#/definitions/requestContactExport_customContactFilter" notifyUrl: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "Webhook that will be called once the export process is finished.\ \ For reference, https://help.brevo.com/hc/en-us/articles/360007666479" requestContactImport: type: "object" properties: fileUrl: type: "string" format: "url" example: "https://importfile.domain.com" description: "Mandatory if fileBody or jsonBody is not defined. URL of the\ \ file to be imported (no local file). Possible file formats: .txt, .csv,\ \ .json" fileBody: type: "string" example: "NAME;SURNAME;EMAIL\nSmith;John;john.smith@example.com\nRoger;Ellie;ellie36@example.com" description: "Mandatory if fileUrl and jsonBody is not defined. CSV content\ \ to be imported. Use semicolon to separate multiple attributes. Maximum\ \ allowed file body size is 10MB . However we recommend a safe limit of\ \ around 8 MB to avoid the issues caused due to increase of file body size\ \ while parsing. Please use fileUrl instead to import bigger files." jsonBody: type: "array" description: "**Mandatory if fileUrl and fileBody is not defined.** JSON content\ \ to be imported. **Maximum allowed json body size is 10MB** . However we\ \ recommend a safe limit of around 8 MB to avoid the issues caused due to\ \ increase of json body size while parsing. Please use fileUrl instead to\ \ import bigger files.\n" items: type: "object" example: email: "ndicky0@ocn.ne.jp" attributes: LNAME: "Noemi" FNAME: "Dicky" COUNTRY: "DE" BIRTHDAY: "11/02/1989" PREFERED_COLOR: "BLACK" description: "List of attributes to be imported" minProperties: 1 maxProperties: 2 additionalProperties: {} listIds: type: "array" description: "Mandatory if newList is not defined. Ids of the lists in which\ \ the contacts shall be imported. For example, [2, 4, 7]." items: type: "integer" format: "int64" example: 76 description: "List Id in which the contacts shall be imported" notifyUrl: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL that will be called once the import process is finished.\ \ For reference, https://help.brevo.com/hc/en-us/articles/360007666479" newList: $ref: "#/definitions/requestContactImport_newList" emailBlacklist: type: "boolean" example: false description: "To blacklist all the contacts for email" default: false smsBlacklist: type: "boolean" example: false description: "To blacklist all the contacts for sms" default: false updateExistingContacts: type: "boolean" example: true description: "To facilitate the choice to update the existing contacts" default: true emptyContactsAttributes: type: "boolean" example: true description: "To facilitate the choice to erase any attribute of the existing\ \ contacts with empty value. emptyContactsAttributes = true means the empty\ \ fields in your import will erase any attribute that currently contain\ \ data in Brevo, & emptyContactsAttributes = false means the empty fields\ \ will not affect your existing data ( only available if `updateExistingContacts`\ \ set to true )" default: false createSmsCampaign: type: "object" required: - "content" - "name" - "sender" properties: name: type: "string" example: "Spring Promo Code" description: "Name of the campaign" sender: type: "string" example: "MyShop" description: "Name of the sender. **The number of characters is limited to\ \ 11 for alphanumeric characters and 15 for numeric characters**" maxLength: 15 content: type: "string" example: "Get a discount by visiting our NY store and saying : Happy Spring\ \ !" description: "Content of the message. The maximum characters used per SMS\ \ is 160, if used more than that, it will be counted as more than one SMS" recipients: $ref: "#/definitions/createSmsCampaign_recipients" scheduledAt: type: "string" example: "2017-05-05T12:30:00+02:00" description: "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ).\ \ Prefer to pass your timezone in date-time format for accurate result." unicodeEnabled: type: "boolean" example: true description: "Format of the message. It indicates whether the content should\ \ be treated as unicode or not." default: false organisationPrefix: type: "string" example: "MyCompany" description: "A recognizable prefix will ensure your audience knows who you\ \ are. Recommended by U.S. carriers. This will be added as your Brand Name\ \ before the message content. **Prefer verifying maximum length of 160 characters\ \ including this prefix in message content to avoid multiple sending of\ \ same sms.**" unsubscribeInstruction: type: "string" example: "send Stop if you want to unsubscribe." description: "Instructions to unsubscribe from future communications. Recommended\ \ by U.S. carriers. Must include **STOP** keyword. This will be added as\ \ instructions after the end of message content. **Prefer verifying maximum\ \ length of 160 characters including this instructions in message content\ \ to avoid multiple sending of same sms.**" updateSmsCampaign: type: "object" properties: name: type: "string" example: "Spring Promo Code" description: "Name of the campaign" sender: type: "string" example: "MyShop" description: "Name of the sender. **The number of characters is limited to\ \ 11 for alphanumeric characters and 15 for numeric characters**" maxLength: 15 content: type: "string" example: "Get a discount by visiting our NY store and saying : Happy Spring!" description: "Content of the message. The maximum characters used per SMS\ \ is 160, if used more than that, it will be counted as more than one SMS" recipients: $ref: "#/definitions/createSmsCampaign_recipients" scheduledAt: type: "string" example: "2017-05-05T12:30:00+02:00" description: "UTC date-time on which the campaign has to run (YYYY-MM-DDTHH:mm:ss.SSSZ).\ \ Prefer to pass your timezone in date-time format for accurate result." unicodeEnabled: type: "boolean" example: true description: "Format of the message. It indicates whether the content should\ \ be treated as unicode or not." default: false organisationPrefix: type: "string" example: "MyCompany" description: "A recognizable prefix will ensure your audience knows who you\ \ are. Recommended by U.S. carriers. This will be added as your Brand Name\ \ before the message content. **Prefer verifying maximum length of 160 characters\ \ including this prefix in message content to avoid multiple sending of\ \ same sms.**" unsubscribeInstruction: type: "string" example: "send Stop if you want to unsubscribe." description: "Instructions to unsubscribe from future communications. Recommended\ \ by U.S. carriers. Must include **STOP** keyword. This will be added as\ \ instructions after the end of message content. **Prefer verifying maximum\ \ length of 160 characters including this instructions in message content\ \ to avoid multiple sending of same sms.**" sendTransacSms: type: "object" required: - "content" - "recipient" - "sender" properties: sender: type: "string" example: "MyShop" description: "Name of the sender. **The number of characters is limited to\ \ 11 for alphanumeric characters and 15 for numeric characters**" maxLength: 15 recipient: type: "string" example: "33689965433" description: "Mobile number to send SMS with the country code" content: type: "string" example: "Enter this code:CCJJG8 to validate your account" description: "Content of the message. If more than 160 characters long, will\ \ be sent as multiple text messages" type: type: "string" example: "marketing" description: "Type of the SMS. Marketing SMS messages are those sent typically\ \ with marketing content. Transactional SMS messages are sent to individuals\ \ and are triggered in response to some action, such as a sign-up, purchase,\ \ etc." enum: - "transactional" - "marketing" default: "transactional" tag: type: "string" example: "accountValidation" description: "Tag of the message" webUrl: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "Webhook to call for each event triggered by the message (delivered\ \ etc.)" unicodeEnabled: type: "boolean" example: true description: "Format of the message. It indicates whether the content should\ \ be treated as unicode or not." default: false organisationPrefix: type: "string" example: "MyCompany" description: "A recognizable prefix will ensure your audience knows who you\ \ are. Recommended by U.S. carriers. This will be added as your Brand Name\ \ before the message content. **Prefer verifying maximum length of 160 characters\ \ including this prefix in message content to avoid multiple sending of\ \ same sms.**" sendTestEmail: type: "object" properties: emailTo: type: "array" description: "List of the email addresses of the recipients whom you wish\ \ to send the test mail. If left empty, the test mail will be sent to your\ \ entire test list. You can not send more than 50 test emails per day." items: type: "string" format: "email" example: "helen.jurger@example.com" description: "Email addres of the recipient" sendTestSms: type: "object" properties: phoneNumber: type: "string" example: "33689965433" description: "Mobile number of the recipient with the country code. This number\ \ must belong to one of your contacts in Brevo account and must not be blacklisted" getTransacAggregatedSmsReport: type: "object" properties: range: type: "string" example: "2016-09-08|2017-04-06" description: "Time frame of the report" requests: type: "integer" format: "int64" example: 263 description: "Number of requests for the timeframe" delivered: type: "integer" format: "int64" example: 249 description: "Number of delivered SMS for the timeframe" hardBounces: type: "integer" format: "int64" example: 1 description: "Number of hardbounces for the timeframe" softBounces: type: "integer" format: "int64" example: 4 description: "Number of softbounces for the timeframe" blocked: type: "integer" format: "int64" example: 2 description: "Number of blocked contact for the timeframe" unsubscribed: type: "integer" format: "int64" example: 6 description: "Number of unsubscription for the timeframe" replied: type: "integer" format: "int64" example: 12 description: "Number of answered SMS for the timeframe" accepted: type: "integer" format: "int64" example: 252 description: "Number of accepted for the timeframe" rejected: type: "integer" format: "int64" example: 8 description: "Number of rejected for the timeframe" getTransacSmsReport: type: "object" properties: reports: type: "array" items: $ref: "#/definitions/getTransacSmsReport_reports" getIp: type: "object" required: - "active" - "domain" - "id" - "ip" properties: id: type: "integer" format: "int64" example: 3 description: "ID of the dedicated IP" ip: type: "string" example: "123.65.8.22" description: "Dedicated IP" active: type: "boolean" example: true description: "Status of the IP (true=active, false=inactive)" domain: type: "string" example: "mailing.myshop.com" description: "Domain associated to the IP" getIpsFromSender: type: "object" required: - "ips" properties: ips: type: "array" description: "Dedicated IP(s) linked to a sender" items: $ref: "#/definitions/getIpFromSender" getIps: type: "object" required: - "ips" properties: ips: type: "array" description: "Dedicated IP(s) available on your account" items: $ref: "#/definitions/getIp" getIpFromSender: type: "object" required: - "domain" - "id" - "ip" - "weight" properties: id: type: "integer" format: "int64" example: 3 description: "ID of the dedicated IP" ip: type: "string" example: "123.65.8.22" description: "Dedicated IP" domain: type: "string" example: "mailing.myshop.dom" description: "Domain associated to the IP" weight: type: "integer" format: "int64" example: 75 description: "Weight of the IP" manageIp: type: "object" properties: ip: type: "string" example: "123.65.8.22" description: "Dedicated ID" getTransacEmailContent: type: "object" required: - "attachmentCount" - "body" - "date" - "email" - "events" - "subject" properties: email: type: "string" format: "email" example: "abc@example.com" description: "Email address to which transactional email has been sent" subject: type: "string" example: "Summer Camp" description: "Subject of the sent email" templateId: type: "integer" format: "int64" example: 2 description: "Id of the template" date: type: "string" example: "2017-03-12T12:30:00Z" description: "Date on which transactional email was sent" events: type: "array" description: "Series of events which occurred on the transactional email" items: $ref: "#/definitions/getTransacEmailContent_events" body: type: "string" example: "

Greetings from the team

This\ \ is the actual html content sent

" description: "Actual content of the transactional email that has been sent" attachmentCount: type: "integer" format: "int64" example: 2 description: "Count of the attachments that were sent in the email" getTransacEmailsList: type: "object" properties: count: type: "integer" format: "int64" example: 5 description: "Total number of transactional emails available on your account\ \ according to the passed filter" transactionalEmails: type: "array" items: $ref: "#/definitions/getTransacEmailsList_transactionalEmails" abTestVersionStats: type: "object" required: - "Version A" - "Version B" properties: Version A: type: "string" example: "50%" description: "percentage of an event for version A" Version B: type: "string" example: "50%" description: "percentage of an event for version B" description: "Percentage of a particular event for both versions" abTestVersionClicks: type: "array" description: "Information on clicked links for a particular version" items: $ref: "#/definitions/abTestVersionClicks_inner" blockDomain: type: "object" required: - "domain" properties: domain: type: "string" example: "example.com" description: "name of the domain to be blocked" getBlockedDomains: type: "object" required: - "domains" properties: domains: type: "array" description: "List of all blocked domains" items: type: "string" example: "contact.com" description: "name of blocked domain" description: "list of blocked domains" getInboundEmailEvents: type: "object" properties: events: type: "array" items: $ref: "#/definitions/getInboundEmailEvents_events" getInboundEmailEventsByUuid: type: "object" properties: receivedAt: type: "string" format: "date-time" example: "2019-05-25T11:53:26Z" description: "Date when email was received on SMTP relay" deliveredAt: type: "string" format: "date-time" description: "Date when email was delivered successfully to client’s webhook" recipient: type: "string" format: "email" description: "Recipient’s email address" sender: type: "string" format: "email" description: "Sender’s email address" messageId: type: "string" description: "Value of the Message-ID header. This will be present only after\ \ the processing is done." subject: type: "string" description: "Value of the Subject header. This will be present only after\ \ the processing is done. " attachments: type: "array" description: "List of attachments of the email. This will be present only\ \ after the processing is done." items: $ref: "#/definitions/getInboundEmailEventsByUuid_attachments" logs: type: "array" description: "List of events/logs that describe the lifecycle of the email\ \ on SIB platform" items: $ref: "#/definitions/getInboundEmailEventsByUuid_logs" getScheduledEmailByBatchId: type: "object" properties: count: type: "integer" description: "Total number of batches" batches: type: "array" items: $ref: "#/definitions/getScheduledEmailByBatchId_batches" getScheduledEmailByMessageId: type: "object" required: - "createdAt" - "scheduledAt" - "status" properties: scheduledAt: type: "string" format: "date-time" description: "Datetime for which the email was scheduled" createdAt: type: "string" format: "date-time" description: "Datetime on which the email was scheduled" status: type: "string" description: "Current status of the scheduled email" enum: - "inProgress" - "queued" - "processed" - "error" subAccountsResponse: type: "object" properties: count: type: "integer" description: "Total number of subaccounts" subAccounts: type: "array" items: $ref: "#/definitions/subAccountsResponse_subAccounts" createSubAccount: type: "object" required: - "companyName" - "email" properties: companyName: type: "string" description: "Set the name of the sub-account company" email: type: "string" description: "Email address for the organization" language: type: "string" description: "Set the language of the sub-account" enum: - "en" - "fr" - "it" - "es" - "pt" - "de" timezone: type: "string" description: "Set the timezone of the sub-account" example: companyName: "Test Sub-account" email: "test-sub@example.com" timezone: "Europe/Paris" language: "fr" createSubAccountResponse: type: "object" required: - "id" properties: id: type: "integer" format: "int64" example: 122 description: "ID of the sub-account created" masterDetailsResponse: type: "object" properties: email: type: "string" description: "Email id of master account" companyName: type: "string" description: "Company name of master account organization" id: type: "integer" format: "int64" description: "Unique identifier of the master account organization" currencyCode: type: "string" description: "Currency code of the master account organization" timezone: type: "string" description: "Timezone of the master account organization" billingInfo: $ref: "#/definitions/masterDetailsResponse_billingInfo" planInfo: $ref: "#/definitions/masterDetailsResponse_planInfo" createApiKeyResponse: type: "object" properties: status: type: "string" description: "Status of the API operation." key: type: "string" description: "API Key" subAccountDetailsResponse: type: "object" properties: name: type: "string" description: "Name of the sub-account user" email: type: "string" description: "Email id of the sub-account organization" companyName: type: "string" description: "Sub-account company name" planInfo: $ref: "#/definitions/subAccountDetailsResponse_planInfo" subAccountUpdatePlanRequest: type: "object" properties: credits: $ref: "#/definitions/subAccountUpdatePlanRequest_credits" features: $ref: "#/definitions/subAccountUpdatePlanRequest_features" description: "Details of the plan to be changed" TaskTypes: type: "object" properties: id: type: "string" example: "61a88a2eb7a574180261234" description: "Id of task type" title: type: "string" example: "Email" description: "Title of task type" description: "Task types details" example: id: "61a88a2eb7a574180261234" title: "Email" Task: type: "object" required: - "name" - "taskTypeId" properties: id: type: "string" example: "61a5cd07ca1347c82306ad06" description: "Unique task id" taskTypeId: type: "string" example: "61a5cd07ca1347c82306ad09" description: "Id for type of task e.g Call / Email / Meeting etc." name: type: "string" example: "Task: Connect with client" description: "Name of task" contactsIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts linked to this task" items: type: "integer" dealsIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Deal ids for deals a task is linked to" items: type: "string" companiesIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Companies ids for companies a task is linked to" items: type: "string" description: "Task Details" example: taskTypeId: "61a5cd07ca1347c82306ad09" name: "Task: Connect with client" contactsIds: - 1 - 2 - 3 dealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" id: "61a5cd07ca1347c82306ad06" companiesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" TaskReminder: type: "object" required: - "types" - "unit" - "value" properties: value: type: "integer" example: 10 description: "Value of time unit before reminder is to be sent" unit: type: "string" description: "Unit of time before reminder is to be sent" enum: - "minutes" - "hours" - "weeks" - "days" types: type: "array" example: - "email" description: "Type of task reminder e.g email, push" items: type: "string" description: "Task reminder date/time for a task" FileList: type: "array" description: "List of files" items: $ref: "#/definitions/FileData" FileDownloadableLink: type: "object" required: - "fileUrl" properties: fileUrl: type: "string" format: "url" example: "https://storage.googleapis.com/brevo-app-crm.......-sample.pdf" description: "A unique link to download the requested file." example: fileUrl: "https://storage.googleapis.com/brevo-app-crm.......-sample.pdf" FileData: type: "object" properties: name: type: "string" example: "example.png" description: "Name of uploaded file" authorId: type: "string" example: "61a5ce58y5d4795761045991" description: "Account id of user which created the file" contactId: type: "integer" format: "int64" example: 1 description: "Contact id of contact on which file is uploaded" dealId: type: "string" example: "61a5ce58c5d4795761045991" description: "Deal id linked to a file" companyId: type: "string" example: "61a5ce58c5d4795761045991" description: "Company id linked to a file" size: type: "integer" format: "int64" example: 10 description: "Size of file in bytes" createdAt: type: "string" format: "date-time" example: "2017-05-01T17:05:03.000Z" description: "File created date/time" description: "File data that is uploaded" example: createdAt: "2017-05-01T17:05:03.000Z" companyId: "61a5ce58c5d4795761045991" size: 10 contactId: 1 dealId: "61a5ce58c5d4795761045991" name: "example.png" authorId: "61a5ce58y5d4795761045991" NoteData: type: "object" required: - "text" properties: text: type: "string" example: "In communication with client for resolution of queries." description: "Text content of a note" minLength: 1 maxLength: 3000 contactIds: type: "array" example: - 247 - 1 - 2 description: "Contact Ids linked to a note" items: type: "integer" dealIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" description: "Deal Ids linked to a note" items: type: "string" companyIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" description: "Company Ids linked to a note" items: type: "string" description: "Note data to be saved" example: companyIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" text: "In communication with client for resolution of queries." dealIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" contactIds: - 247 - 1 - 2 Note: type: "object" required: - "text" properties: id: type: "string" example: "61a5cd07ca1347c82306ad09" description: "Unique note Id" text: type: "string" example: "In communication with client for resolution of queries." description: "Text content of a note" minLength: 1 maxLength: 3000 contactIds: type: "array" example: - 247 - 1 - 2 description: "Contact ids linked to a note" items: type: "integer" dealIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" description: "Deal ids linked to a note" items: type: "string" authorId: type: "object" example: id: "61a5ce58y5d4795761045991" email: "johndoe@example.com" locale: "en_GB" timezone: "Asia/Kolkata" name: fullName: "John Doe" description: "Account details of user which created the note" properties: {} createdAt: type: "string" format: "date-time" example: "2017-05-01T17:05:03.000Z" description: "Note created date/time" updatedAt: type: "string" format: "date-time" example: "2017-05-01T17:05:03.000Z" description: "Note updated date/time" description: "Note Details" example: createdAt: "2017-05-01T17:05:03.000Z" id: "61a5cd07ca1347c82306ad09" text: "In communication with client for resolution of queries." authorId: id: "61a5ce58y5d4795761045991" email: "johndoe@example.com" locale: "en_GB" timezone: "Asia/Kolkata" name: fullName: "John Doe" dealIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" contactIds: - 247 - 1 - 2 updatedAt: "2017-05-01T17:05:03.000Z" NoteId: type: "object" properties: id: type: "string" example: "61a5cd07ca1347c82306ad09" description: "Unique note Id" description: "Updated Note ID" example: id: "61a5cd07ca1347c82306ad09" NoteList: type: "array" description: "List of notes" items: $ref: "#/definitions/Note" TaskList: type: "object" properties: items: type: "array" description: "List of tasks" items: $ref: "#/definitions/Task" description: "List of tasks" example: items: - taskTypeId: "61a5cd07ca1347c82306ad09" name: "Task: Connect with client" contactsIds: - 1 - 2 - 3 dealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" id: "61a5cd07ca1347c82306ad06" companiesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" - taskTypeId: "61a5cd07ca1347c82306ad09" name: "Task: Connect with client" contactsIds: - 1 - 2 - 3 dealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" id: "61a5cd07ca1347c82306ad06" companiesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" PipelineStage: type: "object" properties: id: type: "string" example: "9e577ff7-8e42-4ab3-be26-2b5e01b42518" description: "Stage id" name: type: "string" example: "New" description: "Stage name" description: "List of stages" example: name: "New" id: "9e577ff7-8e42-4ab3-be26-2b5e01b42518" Pipeline: type: "object" properties: stages: type: "array" description: "List of stages" items: $ref: "#/definitions/PipelineStage" description: "List of stages" example: stages: - name: "New" id: "9e577ff7-8e42-4ab3-be26-2b5e01b42518" - name: "New" id: "9e577ff7-8e42-4ab3-be26-2b5e01b42518" DealAttributes: type: "array" description: "List of deal attributes" items: $ref: "#/definitions/DealAttributes_inner" DealsList: type: "object" properties: items: type: "array" description: "List of deals" items: $ref: "#/definitions/Deal" description: "List of Deals" example: items: - linkedCompaniesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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" number_of_activities: 0 id: "629475917295261d9b1f4403" - linkedCompaniesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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" number_of_activities: 0 id: "629475917295261d9b1f4403" Deal: type: "object" properties: id: type: "string" example: "629475917295261d9b1f4403" description: "Unique deal id" attributes: type: "object" example: 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" number_of_activities: 0 description: "Deal attributes with values" properties: {} linkedContactsIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts linked to this deal" items: type: "integer" linkedCompaniesIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Companies ids for companies linked to this deal" items: type: "string" description: "Deal Details" example: linkedCompaniesIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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" number_of_activities: 0 id: "629475917295261d9b1f4403" CompaniesList: type: "object" properties: items: type: "array" description: "List of compaies" items: $ref: "#/definitions/Company" description: "List of companies" example: items: - linkedDealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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 id: "629475917295261d9b1f4403" - linkedDealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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 id: "629475917295261d9b1f4403" Company: type: "object" properties: id: type: "string" example: "629475917295261d9b1f4403" description: "Unique company id" attributes: type: "object" example: 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 description: "Company attributes with values" properties: {} linkedContactsIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts linked to this company" items: type: "integer" linkedDealsIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Deals ids for companies linked to this company" items: type: "string" description: "Company Details" example: linkedDealsIds: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" linkedContactsIds: - 1 - 2 - 3 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 id: "629475917295261d9b1f4403" CompanyAttributes: type: "array" description: "List of company attributes" items: $ref: "#/definitions/CompanyAttributes_inner" ConversationsMessage: type: "object" properties: id: type: "string" example: "eYBEm3gq3zc5ayE2g" description: "Message ID. It can be used for further manipulations with the\ \ message." type: type: "string" example: "agent" description: "`\"agent\"` for agents’ messages, `\"visitor\"` for visitors’\ \ messages." enum: - "agent" - "visitor" text: type: "string" example: "Good morning! How can I help you?" description: "Message text or name of the attached file" visitorId: type: "string" example: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" description: "visitor’s ID" agentId: type: "string" example: "d9nKoegKSjmCtyK78" description: "ID of the agent on whose behalf the message was sent (only in\ \ messages sent by an agent)." agentName: type: "string" example: "Liz" description: "Agent’s name as displayed to the visitor. Only in the messages\ \ sent by an agent." createdAt: type: "integer" format: "int64" example: 1470222622433 description: "Timestamp in milliseconds." minimum: 0 isPushed: type: "boolean" example: true description: "`true` for pushed messages" receivedFrom: type: "string" example: "SuperAwesomeHelpdesk" description: "In two-way integrations, messages sent via REST API can be marked\ \ with receivedFrom property and then filtered out when received in a webhook\ \ to avoid infinite loop." file: $ref: "#/definitions/ConversationsMessage_file" description: "a Conversations message" example: createdAt: 1470222622433 isPushed: true agentId: "d9nKoegKSjmCtyK78" file: isImage: true filename: "conversations.png" size: 15538 imageInfo: previewUrl: "https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/" width: 1129 height: 525 url: "https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/" receivedFrom: "SuperAwesomeHelpdesk" agentName: "Liz" id: "eYBEm3gq3zc5ayE2g" text: "Good morning! How can I help you?" type: "agent" visitorId: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" order: type: "object" required: - "amount" - "createdAt" - "id" - "products" - "status" - "updatedAt" properties: id: type: "string" example: "14" description: "Unique ID of the order." createdAt: type: "string" example: "2021-07-29T20:59:23.383Z" description: "Event occurrence UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when\ \ order is actually created." updatedAt: type: "string" example: "2021-07-30T10:59:23.383Z" description: "Event updated UTC date-time (YYYY-MM-DDTHH:mm:ssZ), when the\ \ status of the order is actually changed/updated." status: type: "string" example: "completed" description: "State of the order." amount: type: "number" example: 308.42 description: "Total amount of the order, including all shipping expenses,\ \ tax and the price of items." products: type: "array" items: $ref: "#/definitions/order_products" email: type: "string" example: "example@brevo.com" description: "Email of the contact, Mandatory if \"phone\" field is not passed\ \ in \"billing\" parameter." billing: $ref: "#/definitions/order_billing" coupons: type: "array" example: - "EASTER15OFF" description: "Coupons applied to the order. Stored case insensitive." items: type: "string" orderBatch: type: "object" required: - "orders" properties: orders: type: "array" description: "array of order objects" items: $ref: "#/definitions/order" notifyUrl: type: "string" example: "https://en.wikipedia.org/wiki/Webhook" description: "Notify Url provided by client to get the status of batch request" createdBatchId: type: "object" required: - "batchId" properties: batchId: type: "number" example: 1.0 description: "Batch ID of the request" getCategories: type: "object" required: - "categories" - "count" properties: categories: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getCategoryDetails" count: type: "integer" format: "int64" example: 17655 description: "Number of categories" getCategoryDetails: type: "object" required: - "createdAt" - "id" - "modifiedAt" - "name" properties: id: type: "string" format: "string" example: "C11" description: "Category ID for which you requested the details" name: type: "string" format: "string" example: "Electronics" description: "Name of the category for which you requested the details" createdAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "Creation UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "Last modification UTC date-time of the category (YYYY-MM-DDTHH:mm:ss.SSSZ)" url: type: "string" format: "string" example: "http://mydomain.com/category/clothing" description: "URL to the category" isDeleted: type: "boolean" format: "string" example: true description: "category deleted from the shop's database" example: createdAt: "2017-05-12T12:30:00.000+0000" isDeleted: true modifiedAt: "2017-05-12T12:30:00.000+0000" name: "Electronics" id: "C11" url: "http://mydomain.com/category/clothing" createUpdateCategory: type: "object" required: - "id" properties: id: type: "string" format: "email" example: "CAT123" description: "Unique Category ID as saved in the shop\n" name: type: "string" example: "Electronics" description: "**Mandatory in case of creation**. Name of the Category, as\ \ displayed in the shop\n" url: type: "string" example: "http://mydomain.com/category/electronics" description: "URL to the category" updateEnabled: type: "boolean" example: false description: "Facilitate to update the existing category in the same request\ \ (updateEnabled = true)" default: false deletedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted\ \ from the shop's database" createUpdateCategories: type: "object" required: - "id" properties: id: type: "string" format: "email" example: "CAT123" description: "Unique Category ID as saved in the shop\n" name: type: "string" example: "Electronics" description: "**Mandatory in case of creation**. Name of the Category, as\ \ displayed in the shop\n" url: type: "string" example: "http://mydomain.com/category/electronics" description: "URL to the category" deletedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the category deleted\ \ from the shop's database" createUpdateBatchCategory: type: "object" required: - "categories" properties: categories: type: "array" description: "array of categories objects" items: $ref: "#/definitions/createUpdateCategories" updateEnabled: type: "boolean" description: "Facilitate to update the existing categories in the same request\ \ (updateEnabled = true)" createCategoryModel: type: "object" properties: id: type: "integer" format: "int64" example: 122 description: "ID of the category when a new category is created" example: id: 122 createUpdateBatchCategoryModel: type: "object" properties: createdCount: type: "integer" format: "int64" example: 7 description: "Number of the new created categories" updatedCount: type: "integer" format: "int64" example: 5 description: "Number of the existing categories updated" example: updatedCount: 5 createdCount: 7 getProducts: type: "object" required: - "count" - "products" properties: products: type: "array" items: type: "object" allOf: - $ref: "#/definitions/getProductDetails" count: type: "integer" format: "int64" example: 17655 description: "Number of products" getProductDetails: type: "object" required: - "createdAt" - "id" - "modifiedAt" - "name" - "s3ThumbAnalytics" - "s3ThumbEditor" properties: id: type: "string" format: "string" example: "P11" description: "Product ID for which you requested the details" name: type: "string" format: "string" example: "Iphone 11" description: "Name of the product for which you requested the details" createdAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)" url: type: "string" format: "string" example: "http://mydomain.com/product/electronics/product1" description: "URL to the product" imageUrl: type: "string" format: "string" example: "http://mydomain.com/product-absoulte-url/img.jpeg" description: "Absolute URL to the cover image of the product" sku: type: "string" format: "string" description: "Product identifier from the shop" price: type: "number" format: "float" description: "Price of the product" categories: type: "array" description: "Category ID-s of the product" items: type: "string" parentId: type: "string" format: "string" description: "Parent product id of the product" s3Original: type: "string" format: "string" description: "S3 url of original image" s3ThumbAnalytics: type: "string" format: "string" description: "S3 thumbnail url of original image in 120x120 dimension for\ \ analytics section" metaInfo: type: "object" example: description: "Shoes for sports" brand: "addidas" description: "Meta data of product such as description, vendor, producer,\ \ stock level, etc." properties: {} s3ThumbEditor: type: "string" format: "string" description: "S3 thumbnail url of original image in 600x400 dimension for\ \ editor section" isDeleted: type: "boolean" format: "string" example: true description: "product deleted from the shop's database" example: s3ThumbAnalytics: "s3ThumbAnalytics" modifiedAt: "2017-05-12T12:30:00.000+0000" url: "http://mydomain.com/product/electronics/product1" parentId: "parentId" createdAt: "2017-05-12T12:30:00.000+0000" metaInfo: description: "Shoes for sports" brand: "addidas" isDeleted: true price: 0.8008282 imageUrl: "http://mydomain.com/product-absoulte-url/img.jpeg" name: "Iphone 11" s3ThumbEditor: "s3ThumbEditor" id: "P11" categories: - "categories" - "categories" sku: "sku" s3Original: "s3Original" createUpdateProduct: type: "object" required: - "id" - "name" properties: id: type: "string" format: "string" example: "P11" description: "Product ID for which you requested the details" name: type: "string" format: "string" example: "Iphone 11" description: "Mandatory in case of creation**. Name of the product for which\ \ you requested the details" url: type: "string" format: "string" example: "http://mydomain.com/product/electronics/product1" description: "URL to the product" imageUrl: type: "string" format: "string" example: "http://mydomain.com/product-absoulte-url/img.jpeg" description: "Absolute URL to the cover image of the product" sku: type: "string" format: "string" description: "Product identifier from the shop" price: type: "number" format: "float" description: "Price of the product" categories: type: "array" description: "Category ID-s of the product" items: type: "string" parentId: type: "string" format: "string" description: "Parent product id of the product" metaInfo: type: "object" example: description: "Shoes for sports" brand: "addidas" description: "Meta data of product such as description, vendor, producer,\ \ stock level. The size of cumulative metaInfo shall not exceed **1000 KB**.\ \ Maximum length of metaInfo object can be 10." additionalProperties: type: "string" updateEnabled: type: "boolean" example: false description: "Facilitate to update the existing category in the same request\ \ (updateEnabled = true)" default: false deletedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted\ \ from the shop's database" createUpdateBatchProducts: type: "object" required: - "products" properties: products: type: "array" description: "array of products objects" items: $ref: "#/definitions/createUpdateProducts" updateEnabled: type: "boolean" description: "Facilitate to update the existing categories in the same request\ \ (updateEnabled = true)" createUpdateProducts: type: "object" required: - "id" - "name" properties: id: type: "string" format: "string" example: "P11" description: "Product ID for which you requested the details" name: type: "string" format: "string" example: "Iphone 11" description: "Mandatory in case of creation**. Name of the product for which\ \ you requested the details" url: type: "string" format: "string" example: "http://mydomain.com/product/electronics/product1" description: "URL to the product" imageUrl: type: "string" format: "string" example: "http://mydomain.com/product-absoulte-url/img.jpeg" description: "Absolute URL to the cover image of the product" sku: type: "string" format: "string" description: "Product identifier from the shop" price: type: "number" format: "float" description: "Price of the product" categories: type: "array" description: "Category ID-s of the product" items: type: "string" parentId: type: "string" format: "string" description: "Parent product id of the product" metaInfo: type: "object" example: description: "Shoes for sports" brand: "addidas" description: "Meta data of product such as description, vendor, producer,\ \ stock level. The size of cumulative metaInfo shall not exceed **1000 KB**.\ \ Maximum length of metaInfo object can be 10." additionalProperties: type: "string" deletedAt: type: "string" example: "2017-05-12T12:30:00.000+0000" description: "UTC date-time (YYYY-MM-DDTHH:mm:ss.SSSZ) of the product deleted\ \ from the shop's database" createProductModel: type: "object" properties: id: type: "integer" format: "int64" example: 122 description: "ID of the Product when a new product is created" createUpdateBatchProductsModel: type: "object" properties: createdCount: type: "integer" format: "int64" example: 7 description: "Number of the new created products" updatedCount: type: "integer" format: "int64" example: 5 description: "Number of the existing products updated" sendWhatsappMessage: type: "object" required: - "contactNumbers" - "senderNumber" properties: templateId: type: "integer" example: 123 description: "ID of the template to send" text: type: "string" example: "Hi! There i am a message" description: "Text to be sent as message body (will be overridden if templateId\ \ is passed in the same request)" senderNumber: type: "string" format: "mobile" example: "919876543210" description: "WhatsApp Number with country code. Example, 85264318721" contactNumbers: type: "array" description: "List of phone numbers of the contacts" items: type: "string" format: "mobile" example: "919876543210" description: "WhatsApp Number with country code. Example, 85264318721" getWhatsappEventReport: type: "object" properties: events: type: "array" items: $ref: "#/definitions/getWhatsappEventReport_events" getExternalFeedByUUID: type: "object" required: - "authType" - "cache" - "createdAt" - "headers" - "id" - "maxRetries" - "modifiedAt" - "name" - "url" properties: id: type: "string" format: "uuidv4" example: "54377442-20a2-4c20-b761-d636c72de7b7" description: "ID of the feed" name: type: "string" example: "New feed" description: "Name of the feed" url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the feed" authType: type: "string" description: "Auth type of the feed: * `basic` * `token` * `noAuth`\n" enum: - "basic" - "token" - "noAuth" username: type: "string" example: "user" description: "Username for authType `basic`" password: type: "string" example: "password" description: "Password for authType `basic`" token: type: "string" example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" description: "Token for authType `token`" headers: type: "array" description: "Custom headers for the feed" items: $ref: "#/definitions/getExternalFeedByUUID_headers" maxRetries: type: "integer" example: 5 description: "Maximum number of retries on the feed url" minimum: 0 maximum: 5 cache: type: "boolean" example: true description: "Toggle caching of feed url response" createdAt: type: "string" format: "date-time" example: "2022-10-06T05:03:47.053000000Z" description: "Datetime on which the feed was created" modifiedAt: type: "string" format: "date-time" example: "2022-10-06T05:03:47.053000000Z" description: "Datetime on which the feed was modified" getAllExternalFeeds: type: "object" properties: count: type: "integer" description: "Total number of batches" feeds: type: "array" items: $ref: "#/definitions/getAllExternalFeeds_feeds" createExternalFeed: type: "object" required: - "name" - "url" properties: name: type: "string" example: "New feed" description: "Name of the feed" url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the feed" authType: type: "string" description: "Auth type of the feed:\n * `basic`\n * `token`\n * `noAuth`\n" enum: - "basic" - "token" - "noAuth" default: "noAuth" username: type: "string" example: "user" description: "Username for authType `basic`" password: type: "string" example: "password" description: "Password for authType `basic`" token: type: "string" example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" description: "Token for authType `token`" headers: type: "array" example: - name: "header1" value: "value1" - name: "header2" value: "value2" description: "Custom headers for the feed" items: $ref: "#/definitions/getExternalFeedByUUID_headers" maxRetries: type: "integer" example: 5 description: "Maximum number of retries on the feed url" minimum: 0 maximum: 5 cache: type: "boolean" example: true description: "Toggle caching of feed url response" default: false updateExternalFeed: type: "object" properties: name: type: "string" example: "New feed" description: "Name of the feed" url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the feed" authType: type: "string" description: "Auth type of the feed:\n * `basic`\n * `token`\n * `noAuth`\n" enum: - "basic" - "token" - "noAuth" username: type: "string" example: "user" description: "Username for authType `basic`" password: type: "string" example: "password" description: "Password for authType `basic`" token: type: "string" example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" description: "Token for authType `token`" headers: type: "array" example: - name: "header1" value: "value1" - name: "header2" value: "value2" description: "Custom headers for the feed" items: $ref: "#/definitions/getExternalFeedByUUID_headers" maxRetries: type: "integer" example: 5 description: "Maximum number of retries on the feed url" minimum: 0 maximum: 5 cache: type: "boolean" example: true description: "Toggle caching of feed url response" default: false exportWebhooksHistory: type: "object" required: - "event" - "notifyURL" properties: days: type: "integer" example: 7 description: "Number of days in the past including today (positive integer).\ \ _Not compatible with 'startDate' and 'endDate'_" startDate: type: "string" example: "2023-02-13T00:00:00.000+0000" description: "Mandatory if endDate is used. Starting date of the history (YYYY-MM-DD).\ \ Must be lower than equal to endDate" endDate: type: "string" example: "2023-02-17T00:00:00.000+0000" description: "Mandatory if startDate is used. Ending date of the report (YYYY-MM-DD).\ \ Must be greater than equal to startDate" sort: type: "string" example: "desc" description: "Sorting order of records (asc or desc)" event: type: "string" example: "request" description: "Filter the history for a specific event type" enum: - "invalid_parameter" - "missing_parameter" - "hardBounce" - "softBounce" - "delivered\"" - "spam" - "request" - "opened" - "click" - "invalid" - "deferred" - "blocked" - "unsubscribed" - "error" - "uniqueOpened" - "loadedByProxy" - "allEvents" notifyURL: type: "string" example: "https://brevo.com" description: "Webhook URL to receive CSV file link" webhookId: type: "integer" example: 2345 description: "Filter the history for a specific webhook id" email: type: "string" example: "example@brevo.com" description: "Filter the history for a specific email" messageId: type: "integer" example: "<23befbae-1505-47a8-bd27-e30ef739f32c@fr.sib>" description: "Filter the history for a specific message id" body: type: "object" required: - "name" properties: name: type: "string" example: "company" description: "Name of company" attributes: type: "object" example: domain: "https://example.com" industry: "Fabric" owner: "60e68d60582a3b006f524197" description: "Attributes for company creation" properties: {} countryCode: type: "integer" format: "int64" example: 91 description: "Country code if phone_number is passed in attributes." inline_response_200: type: "object" required: - "id" properties: id: type: "string" example: "61a5cd07ca1347c82306ad06" description: "Unique company id" description: "Created company id" example: id: "61a5cd07ca1347c82306ad06" body_1: type: "object" properties: name: type: "string" example: "company" description: "Name of company" attributes: type: "object" example: 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 description: "Attributes for company update" properties: {} countryCode: type: "integer" format: "int64" example: 91 description: "Country code if phone_number is passed in attributes." body_2: type: "object" properties: linkContactIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts to be linked with company" items: type: "integer" format: "int64" unlinkContactIds: type: "array" example: - 4 - 5 - 6 description: "Contact ids for contacts to be unlinked from company" items: type: "integer" format: "int64" linkDealsIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Deals ids for deals to be linked with company" items: type: "string" unlinkDealsIds: type: "array" example: - "61a5ce58c5d4795761045994" - "61a5ce58c5d479576104595" - "61a5ce58c5d4795761045996" description: "Deals ids for deals to be unlinked from company" items: type: "string" body_3: type: "object" required: - "name" properties: name: type: "string" example: "Deal: Connect with company" description: "Name of deal" attributes: type: "object" example: deal_owner: "6093d2425a9b436e9519d034" amount: 12 description: "Attributes fo\\r deal creation" properties: {} inline_response_201: type: "object" required: - "id" properties: id: type: "string" example: "61a5cd07ca1347c82306ad06" description: "Unique deal id" description: "Created deal id" example: id: "61a5cd07ca1347c82306ad06" body_4: type: "object" properties: name: type: "string" example: "Deal: Connect with client" description: "Name of deal" attributes: type: "object" example: deal_owner: "6093d2425a9b436e9519d034" amount: 12 description: "Attributes for deal update" properties: {} body_5: type: "object" properties: linkContactIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts to be linked with deal" items: type: "integer" format: "int64" unlinkContactIds: type: "array" example: - 4 - 5 - 6 description: "Contact ids for contacts to be unlinked from deal" items: type: "integer" format: "int64" linkCompanyIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Company ids to be linked with deal" items: type: "string" unlinkCompanyIds: type: "array" example: - "61a5ce58c5d4795761045994" - "61a5ce58c5d479576104595" - "61a5ce58c5d4795761045996" description: "Company ids to be unlinked from deal" items: type: "string" body_6: type: "object" required: - "date" - "name" - "taskTypeId" properties: name: type: "string" example: "Task: Connect with client" description: "Name of task" duration: type: "integer" format: "int64" example: 600000 description: "Duration of task in milliseconds [1 minute = 60000 ms]" minimum: 0 taskTypeId: type: "string" example: "61a5cd07ca1347c82306ad09" description: "Id for type of task e.g Call / Email / Meeting etc." date: type: "string" format: "date-time" example: "2021-11-01T17:44:54.668Z" description: "Task due date and time" notes: type: "string" example: "In communication with client for resolution of queries." description: "Notes added to a task" done: type: "boolean" example: false description: "Task marked as done" assignToId: type: "string" example: "5faab4b7f195bb3c4c31e62a" description: "User id to whom task is assigned" contactsIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts linked to this task" items: type: "integer" dealsIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Deal ids for deals a task is linked to" items: type: "string" companiesIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Companies ids for companies a task is linked to" items: type: "string" reminder: $ref: "#/definitions/TaskReminder" inline_response_201_1: type: "object" required: - "id" properties: id: type: "string" example: "61a5cd07ca1347c82306ad06" description: "Unique task id" description: "Task Details" example: id: "61a5cd07ca1347c82306ad06" body_7: type: "object" properties: name: type: "string" example: "Task: Connect with client" description: "Name of task" duration: type: "integer" example: 600000 description: "Duration of task in milliseconds [1 minute = 60000 ms]" taskTypeId: type: "string" example: "61a5cd07ca1347c82306ad09" description: "Id for type of task e.g Call / Email / Meeting etc." date: type: "string" format: "date-time" example: "2021-11-01T17:44:54.668Z" description: "Task date/time" notes: type: "string" example: "In communication with client for resolution of queries." description: "Notes added to a task" done: type: "boolean" example: false description: "Task marked as done" assignToId: type: "string" example: "5faab4b7f195bb3c4c31e62a" description: "User id to whom task is assigned" contactsIds: type: "array" example: - 1 - 2 - 3 description: "Contact ids for contacts linked to this task" items: type: "integer" dealsIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Deal ids for deals a task is linked to" items: type: "string" companiesIds: type: "array" example: - "61a5ce58c5d4795761045990" - "61a5ce58c5d4795761045991" - "61a5ce58c5d4795761045992" description: "Companies ids for companies a task is linked to" items: type: "string" body_8: type: "object" required: - "text" - "visitorId" properties: visitorId: type: "string" example: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" description: "visitor’s ID received from a webhook or generated by you to bind existing user account to Conversations" text: type: "string" example: "Hello! How can I help you?" description: "message text" agentId: type: "string" example: "d9nKoegKSjmCtyK78" description: "agent ID. It can be found on agent’s page or received from a webhook.\ \ Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom`\ \ instead (all 3 fields required)." receivedFrom: type: "string" example: "SuperAwesomeHelpdesk" description: "mark your messages to distinguish messages created by you from\ \ the others." agentEmail: type: "string" format: "email" example: "liz@getwear.com" description: "agent email. When sending messages from a standalone system,\ \ it’s hard to maintain a 1-to-1 relationship between the users of both\ \ systems. In this case, an agent can be specified by their email address." agentName: type: "string" example: "Liz" description: "agent name" body_9: required: - "text" properties: text: type: "string" description: "edited message text" example: edition: value: text: "Good morning! How can I help you?" body_10: type: "object" required: - "text" - "visitorId" properties: visitorId: type: "string" example: "kZMvWhf8npAu3H6qd57w2Hv6nh6rnxvg" description: "visitor’s ID received from a webhook or generated by you to bind existing user account to Conversations" text: type: "string" example: "Your order has shipped! Here’s your tracking number: 9114 5847 3325\ \ 9667 4328 88" description: "message text" agentId: type: "string" example: "PjRBMhWGen6aRHjif" description: "agent ID. It can be found on agent’s page or received from a webhook.\ \ Optional if `groupId` is set." groupId: type: "string" example: "PjRBMhWGen6aRHjif" description: "group ID. It can be found on group’s page. Optional if `agentId`\ \ is set." body_11: type: "object" required: - "text" properties: text: type: "string" example: "Your order has shipped! Here’s your tracking number: 9114 5847 4668\ \ 7775 9233 54" description: "edited message text" body_12: type: "object" properties: agentId: type: "string" example: "d9nKoegKSjmCtyK78" description: "agent ID. It can be found on agent’s page or received from a webhook.\ \ Alternatively, you can use `agentEmail` + `agentName` + `receivedFrom`\ \ instead (all 3 fields required)." receivedFrom: type: "string" example: "SuperAwesomeHelpdesk" description: "mark your messages to distinguish messages created by you from\ \ the others." agentEmail: type: "string" format: "email" example: "liz@getwear.com" description: "agent email. When sending online pings from a standalone system,\ \ it’s hard to maintain a 1-to-1 relationship between the users of both\ \ systems. In this case, an agent can be specified by their email address.\ \ If there’s no agent with the specified email address in your Brevo organization,\ \ a dummy agent will be created automatically." agentName: type: "string" example: "Liz" description: "agent name." inline_response_201_2: type: "object" required: - "messageId" properties: messageId: type: "string" format: "uuidv4" example: "23befbae-1505-47a8-bd27-e30ef739f32c" description: "messageId of sent message" example: messageId: "23befbae-1505-47a8-bd27-e30ef739f32c" inline_response_201_3: type: "object" required: - "id" properties: id: type: "string" format: "uuidv4" example: "23befbae-1505-47a8-bd27-e30ef739f32c" description: "ID of the object created" example: id: "23befbae-1505-47a8-bd27-e30ef739f32c" getAccount_plan: type: "object" required: - "credits" - "creditsType" - "type" properties: type: type: "string" example: "subscription" description: "Displays the plan type of the user" enum: - "payAsYouGo" - "free" - "subscription" - "sms" - "reseller" creditsType: type: "string" example: "sendLimit" description: "This is the type of the credit, \"Send Limit\" is one of the\ \ possible types of credit of a user. \"Send Limit\" implies the total number\ \ of emails you can send to the subscribers in your account." enum: - "sendLimit" credits: type: "number" format: "float" example: 8755.0 description: "Remaining credits of the user" startDate: type: "string" format: "date" example: "2016-12-31" description: "Date of the period from which the plan will start (only available\ \ for \"subscription\" and \"reseller\" plan type)" endDate: type: "string" format: "date" example: "2017-01-31" description: "Date of the period from which the plan will end (only available\ \ for \"subscription\" and \"reseller\" plan type)" userLimit: type: "integer" example: 10 description: "Only in case of reseller account. It implies the total number\ \ of child accounts you can add to your account." getAccount_relay_data: type: "object" required: - "port" - "relay" - "userName" properties: userName: type: "string" format: "email" example: "john.smith@example.com" description: "Email to use as login on transactional platform" relay: type: "string" example: "relay.domain.com" description: "URL of the SMTP Relay" port: type: "integer" example: 125 description: "Port used for SMTP Relay" description: "Data regarding the transactional email account" getAccount_relay: type: "object" required: - "data" - "enabled" properties: enabled: type: "boolean" example: true description: "Status of your transactional email Account (true=Enabled, false=Disabled)" data: $ref: "#/definitions/getAccount_relay_data" description: "Information about your transactional email account" getAccount_marketingAutomation: type: "object" required: - "enabled" properties: key: type: "string" example: "iso05aopqych87ysy0jymf" description: "Marketing Automation Tracker ID" enabled: type: "boolean" example: false description: "Status of Marketing Automation Plateform activation for your\ \ account (true=enabled, false=disabled)" getAccountActivity_logs: type: "object" required: - "action" - "date" - "user_agent" - "user_email" - "user_ip" properties: action: type: "string" example: "login-success" description: "Type of activity in the account." date: type: "string" example: "2023-03-27T16:30:00Z" description: "Time of the activity." user_email: type: "string" example: "test@mycompany.com" description: "Email address of the user who performed activity in the account." user_ip: type: "string" example: "192.158.1.38" description: "IP address of the user who performed activity in the account." user_agent: type: "string" example: "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us)" description: "Browser details of the user who performed the activity." getChildInfo_credits: type: "object" properties: emailCredits: type: "integer" format: "int64" example: 98555 description: "Email credits available for your child" smsCredits: type: "integer" format: "int64" example: 87556 description: "SMS credits available for your child" description: "Credits available for your child" getChildInfo_statistics: type: "object" properties: previousMonthTotalSent: type: "integer" format: "int64" example: 7654 description: "Overall emails sent for the previous month" currentMonthTotalSent: type: "integer" format: "int64" example: 4566 description: "Overall emails sent for current month" totalSent: type: "integer" format: "int64" example: 987554 description: "Overall emails sent for since the account exists" description: "Statistics about your child account activity" getChildInfo_apiKeys_v2: type: "object" required: - "key" - "name" properties: name: type: "string" example: "N˚2" description: "Name of the key for version 2" key: type: "string" example: "nOpxxxxxy7z" description: "API Key for version 2" getChildInfo_apiKeys_v3: type: "object" required: - "key" - "name" properties: name: type: "string" example: "N˚3" description: "Name of the key for version 3" key: type: "string" example: "xkeysib-21881axxxxxcc92e04-mIrexxxx7z" description: "API Key for version 3" getChildInfo_apiKeys: type: "object" required: - "v2" properties: v2: type: "array" items: $ref: "#/definitions/getChildInfo_apiKeys_v2" v3: type: "array" items: $ref: "#/definitions/getChildInfo_apiKeys_v3" description: "API Keys associated to child account" getExtendedClient_address: type: "object" required: - "city" - "country" - "street" - "zipCode" properties: street: type: "string" example: "47 Harbour Street" description: "Street information" city: type: "string" example: "New-York" description: "City information" zipCode: type: "string" example: "9867" description: "Zip Code information" country: type: "string" example: "United States of America" description: "Country information" description: "Address informations" getSendersList_ips: type: "object" required: - "domain" - "ip" - "weight" properties: ip: type: "string" example: "123.98.689.7" description: "Dedicated IP available in your account" domain: type: "string" example: "mycompany.com" description: "Domain of the IP" weight: type: "integer" format: "int64" example: 50 description: "Weight of the IP for this sender" getSendersList_senders: type: "object" required: - "active" - "email" - "id" - "name" properties: id: type: "integer" format: "int64" example: 0 description: "Id of the sender" name: type: "string" example: "Marketing" description: "From Name associated to the sender" email: type: "string" example: "marketing@mycompany.com" description: "From Email associated to the sender" active: type: "boolean" example: false description: "Status of sender (true=activated, false=deactivated)" ips: type: "array" description: "List of dedicated IP(s) available in the account. This data\ \ is displayed only for dedicated IPs" items: $ref: "#/definitions/getSendersList_ips" getDomainsList_domains: type: "object" required: - "authenticated" - "domain_name" - "id" - "verified" properties: id: type: "integer" format: "int64" example: 1 description: "Id of the domain" domain_name: type: "string" example: "mycompany.com" description: "Domain name" authenticated: type: "boolean" example: true description: "Status of domain authentication (true=authenticated, false=non\ \ authenticated)" verified: type: "boolean" example: false description: "Status of domain verification (true=verified, false=non verified)" ip: type: "string" example: "123.98.689.7" description: "Dedicated IP associated with domain" createSender_ips: type: "object" required: - "domain" - "ip" properties: ip: type: "string" example: "123.98.689.7" description: "Dedicated IP available in your account" domain: type: "string" example: "mycompany.com" description: "Domain of the IP" weight: type: "integer" format: "int64" example: 50 description: "Weight to apply to the IP. Sum of all IP weights must be 100.\ \ Should be passed for either ALL or NONE of the IPs. If it's not passed,\ \ the sending will be equally balanced on all IPs." minimum: 1 maximum: 100 remainingCreditModel_child: type: "object" required: - "email" - "sms" properties: sms: type: "number" format: "double" example: 500.0 description: "SMS Credits remaining for child account" email: type: "number" format: "double" example: 2000.0 description: "Email Credits remaining for child account" description: "Credits remaining for child account" remainingCreditModel_reseller: type: "object" required: - "email" - "sms" properties: sms: type: "number" format: "double" example: 12900.0 description: "SMS Credits remaining for reseller account" email: type: "number" format: "double" example: 2000000.0 description: "Email Credits remaining for reseller account" getExtendedCampaignOverview_sender: type: "object" properties: name: type: "string" example: "Marketing" description: "Sender name of the campaign" email: type: "string" format: "email" example: "marketing@mycompany.com" description: "Sender email of the campaign" id: type: "string" example: "43" description: "Sender id of the campaign" getWATemplates_templates: type: "object" required: - "category" - "createdAt" - "id" - "language" - "modifiedAt" - "name" - "status" properties: id: type: "string" example: "235" description: "id of the template" name: type: "string" example: "Test template" description: "Name of the WhatsApp template" status: type: "string" example: "approved" description: "Status of the WhatsApp template" language: type: "string" example: "en" description: "Language in which template exists" category: type: "string" example: "MARKETING" description: "category of the template" errorReason: type: "string" example: "NONE" description: "Error reason in the template creation" createdAt: type: "string" example: "2017-06-01T12:30:00.000+0000" description: "Creation UTC date-time of the whatsApp template (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-01T12:30:00.000+0000" description: "UTC date-time of last modification of the whatsApp template\ \ (YYYY-MM-DDTHH:mm:ss.SSSZ)" getWhatsappCampaigns_campaigns: type: "object" required: - "campaignName" - "campaignStatus" - "createdAt" - "id" - "modifiedAt" - "scheduledAt" - "templateId" properties: id: type: "integer" format: "int64" example: 1672035851100690 description: "ID of the WhatsApp Campaign" campaignName: type: "string" example: "Test Campaign" description: "Name of the WhatsApp Campaign" templateId: type: "string" example: "637660278078655" description: "Id of the WhatsApp template" campaignStatus: type: "string" example: "draft" description: "Status of the WhatsApp Campaign" enum: - "draft" - "scheduled" - "pending" - "approved" - "running" - "suspended" - "rejected" - "sent" scheduledAt: type: "string" example: "2017-06-01T12:30:00.000+0000" description: "UTC date-time on which WhatsApp campaign is scheduled. Should\ \ be in YYYY-MM-DDTHH:mm:ss.SSSZ format" errorReason: type: "string" example: "NONE" description: "Error reason in the campaign creation" invalidatedContacts: type: "integer" format: "int64" example: 0 description: "Count of invalidated contacts" readPercentage: type: "number" format: "float" example: 28.57 description: "Read percentage of the the WhatsApp campaign created" stats: $ref: "#/definitions/WhatsappCampStats" createdAt: type: "string" example: "2017-06-01T12:30:00.000+0000" description: "Creation UTC date-time of the WhatsApp campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)" modifiedAt: type: "string" example: "2017-05-01T12:30:00.000+0000" description: "UTC date-time of last modification of the whatsapp template\ \ (YYYY-MM-DDTHH:mm:ss.SSSZ)" createWhatsAppCampaign_recipients: type: "object" properties: excludedIds: type: "array" description: "List ids to exclude from the campaign" items: type: "integer" format: "int64" example: 8 listIds: type: "array" description: "**Mandatory if scheduledAt is not empty**. List Ids to send\ \ the campaign to\n" items: type: "integer" format: "int64" example: 32 segments: type: "array" description: "**Mandatory if listIds are not used**. Segment ids to send the\ \ campaign to.\n" items: type: "integer" format: "int64" example: 23 description: "Segment ids and List ids to include/exclude from campaign" createDomainModel_dns_records_dkim_record: type: "object" properties: type: type: "string" value: type: "string" host_name: type: "string" status: type: "boolean" example: type: "type" value: "value" host_name: "host_name" status: true createDomainModel_dns_records: type: "object" properties: dkim_record: $ref: "#/definitions/createDomainModel_dns_records_dkim_record" brevo_code: $ref: "#/definitions/createDomainModel_dns_records_dkim_record" example: dkim_record: type: "type" value: "value" host_name: "host_name" status: true brevo_code: type: "type" value: "value" host_name: "host_name" status: true postContactInfo_contacts: type: "object" properties: success: type: "array" items: type: "string" format: "email" example: "jeff32@example.com, jim56@example.com" description: "Email addresses which are successfully imported" failure: type: "array" items: type: "string" format: "email" example: "jeff32@example.com, jim56@example.com" description: "Email addresses which can not be imported, could be already\ \ in/out list and/or doesn't exist" total: type: "integer" format: "int64" example: 27 description: "Displays the count of total number of contacts removed from\ \ list when user opts for \"all\" option." processId: type: "integer" format: "int64" example: 78 description: "Id of the process created to remove contacts from list when\ \ user opts for \"all\" option." example: total: 27 processId: 78 success: - "jeff32@example.com, jim56@example.com" - "jeff32@example.com, jim56@example.com" failure: - "jeff32@example.com, jim56@example.com" - "jeff32@example.com, jim56@example.com" getTransacBlockedContacts_reason: type: "object" properties: code: type: "string" example: "AdminBlocked" description: "Reason code for blocking / unsubscribing (This code is safe\ \ for comparison)" enum: - "unsubscribedViaMA" - "unsubscribedViaEmail" - "adminBlocked" - "unsubscribedViaApi" - "hardBounce" - "contactFlaggedAsSpam" message: type: "string" example: "Admin blocked" description: "Reason for blocking / unsubscribing (This string is not safe\ \ for comparison)" description: "Reason for blocking / unsubscribing" example: "\"Admin blocked\"" getTransacBlockedContacts_contacts: type: "object" required: - "blockedAt" - "email" - "reason" - "senderEmail" properties: email: type: "string" format: "email" example: "john.smith@example.com" description: "Email address of the blocked or unsubscribed contact" senderEmail: type: "string" format: "email" example: "john.smith@example.com" description: "Sender email address of the blocked or unsubscribed contact" reason: $ref: "#/definitions/getTransacBlockedContacts_reason" blockedAt: type: "string" example: "2017-05-01T12:30:00Z" description: "Date when the contact was blocked or unsubscribed on" getReports_reports: type: "object" required: - "blocked" - "clicks" - "date" - "delivered" - "hardBounces" - "invalid" - "opens" - "requests" - "softBounces" - "spamReports" - "uniqueClicks" - "uniqueOpens" - "unsubscribed" properties: date: type: "string" format: "date" example: "2017-04-06" description: "Date of the statistics" requests: type: "integer" format: "int64" example: 65 description: "Number of requests for the date" delivered: type: "integer" format: "int64" example: 63 description: "Number of delivered emails for the date" hardBounces: type: "integer" format: "int64" example: 1 description: "Number of hardbounces for the date" softBounces: type: "integer" format: "int64" example: 1 description: "Number of softbounces for the date" clicks: type: "integer" format: "int64" example: 6 description: "Number of clicks for the date" uniqueClicks: type: "integer" format: "int64" example: 5 description: "Number of unique clicks for the date" opens: type: "integer" format: "int64" example: 58 description: "Number of openings for the date" uniqueOpens: type: "integer" format: "int64" example: 52 description: "Number of unique openings for the date" spamReports: type: "integer" format: "int64" example: 0 description: "Number of complaints (spam reports) for the date" blocked: type: "integer" format: "int64" example: 0 description: "Number of blocked emails for the date" invalid: type: "integer" format: "int64" example: 0 description: "Number of invalid emails for the date" unsubscribed: type: "integer" format: "int64" example: 0 description: "Number of unsubscribed emails for the date" getEmailEventReport_events: type: "object" required: - "date" - "email" - "event" - "messageId" properties: email: type: "string" format: "email" example: "john.smith@example.com" description: "Email address which generates the event" date: type: "string" example: "2017-03-12T12:30:00Z" description: "UTC date-time on which the event has been generated" subject: type: "string" example: "Sib client test" description: "Subject of the event" messageId: type: "string" example: "<201798300811.5787683@relay.domain.com>" description: "Message ID which generated the event" event: type: "string" example: "delivered" description: "Event which occurred" enum: - "bounces" - "hardBounces" - "softBounces" - "delivered" - "spam" - "requests" - "opened" - "clicks" - "invalid" - "deferred" - "blocked" - "unsubscribed" - "error" - "loadedByProxy" reason: type: "string" example: "Error connection timeout" description: "Reason of bounce (only available if the event is hardbounce\ \ or softbounce)" tag: type: "string" example: "OrderConfirmation" description: "Tag of the email which generated the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has opened the email or clicked on the\ \ link (only available if the event is opened or clicks)" link: type: "string" example: "https://www.someexamplelink.com" description: "The link which is sent to the user (only available if the event\ \ is requests or opened or clicks)" from: type: "string" format: "email" example: "john@example.com" description: "Sender email from which the emails are sent" templateId: type: "integer" format: "int64" example: 4 description: "ID of the template (only available if the email is template\ \ based)" getSmsEventReport_events: type: "object" properties: phoneNumber: type: "string" example: "00189001094" description: "Phone number which has generated the event" date: type: "string" example: "2017-03-12T12:30:00Z" description: "UTC date-time on which the event has been generated" messageId: type: "string" example: "1472640582425378" description: "Message ID which generated the event" event: type: "string" example: "accepted" description: "Event which occurred" enum: - "bounces" - "hardBounces" - "softBounces" - "delivered" - "sent" - "accepted" - "unsubscription" - "replies" - "blocked" - "rejected" reason: type: "string" example: "Message is undeliverable due to an incorrect / invalid / blacklisted\ \ / permanently barred MSISDN for this operator" description: "Reason of bounce (only available if the event is hardbounce\ \ or softbounce)" reply: type: "string" tag: type: "string" example: "CabWaiting" description: "Tag of the SMS which generated the event" getSmtpTemplateOverview_sender: type: "object" properties: name: type: "string" example: "Mary form MyShop" description: "From email for the template" email: type: "string" format: "email" example: "contact@myshop.fr" description: "From email for the template" id: type: "string" example: "43" description: "Sender id of the template" getExtendedContactDetails_statistics_messagesSent: type: "object" required: - "campaignId" - "eventTime" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" getExtendedContactDetails_statistics_unsubscriptions_userUnsubscription: type: "object" required: - "campaignId" - "eventTime" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has unsubscribed" getExtendedContactDetails_statistics_unsubscriptions_adminUnsubscription: type: "object" required: - "eventTime" properties: eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has been unsubscribed" getExtendedContactDetails_statistics_unsubscriptions: type: "object" required: - "adminUnsubscription" - "userUnsubscription" properties: userUnsubscription: type: "array" description: "Contact unsubscribe via unsubscription link in a campaign" items: $ref: "#/definitions/getExtendedContactDetails_statistics_unsubscriptions_userUnsubscription" adminUnsubscription: type: "array" description: "Contact has been unsubscribed from the administrator" items: $ref: "#/definitions/getExtendedContactDetails_statistics_unsubscriptions_adminUnsubscription" description: "Listing of the unsubscription for the contact" getExtendedContactDetails_statistics_opened: type: "object" required: - "campaignId" - "count" - "eventTime" - "ip" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" count: type: "integer" format: "int64" example: 1 description: "Number of openings for the campaign" eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has opened the email" getExtendedContactDetails_statistics_links: type: "object" required: - "count" - "eventTime" - "ip" - "url" properties: count: type: "integer" format: "int64" example: 1 description: "Number of clicks on this link for the campaign" eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has clicked on the link" url: type: "string" example: "www.myshop.com" description: "URL of the clicked link" getExtendedContactDetails_statistics_clicked: type: "object" required: - "campaignId" - "links" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" links: type: "array" description: "Listing of the clicked links for the campaign" items: $ref: "#/definitions/getExtendedContactDetails_statistics_links" getExtendedContactDetails_statistics_delivered: type: "object" required: - "campaignId" - "eventTime" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" eventTime: type: "string" example: "2017-03-12T20:15:13.000+0000" description: "UTC date-time of the event" getExtendedContactDetails_statistics: type: "object" properties: messagesSent: type: "array" description: "Listing of the sent campaign for the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" hardBounces: type: "array" description: "Listing of the hardbounes generated by the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" softBounces: type: "array" description: "Listing of the softbounes generated by the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" complaints: type: "array" description: "Listing of the complaints generated by the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_messagesSent" unsubscriptions: $ref: "#/definitions/getExtendedContactDetails_statistics_unsubscriptions" opened: type: "array" description: "Listing of the openings generated by the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_opened" clicked: type: "array" description: "Listing of the clicks generated by the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_clicked" transacAttributes: type: "array" description: "Listing of the transactional attributes for the contact" items: type: "object" properties: {} delivered: type: "array" description: "Listing of the delivered campaign for the contact" items: $ref: "#/definitions/getExtendedContactDetails_statistics_delivered" description: "Campaign statistics of the contact" getContactCampaignStats_unsubscriptions: type: "object" required: - "adminUnsubscription" - "userUnsubscription" properties: userUnsubscription: type: "array" description: "Contact has unsubscribed via the unsubscription link in the\ \ email" items: $ref: "#/definitions/getExtendedContactDetails_statistics_unsubscriptions_userUnsubscription" adminUnsubscription: type: "array" description: "Contact has been unsubscribed from the administrator" items: $ref: "#/definitions/getExtendedContactDetails_statistics_unsubscriptions_adminUnsubscription" getContactCampaignStats_opened: type: "object" required: - "campaignId" - "count" - "eventTime" - "ip" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" count: type: "integer" format: "int64" example: 3 description: "Number of openings of the campaign" eventTime: type: "string" example: "2017-03-12T20:15:13Z" description: "UTC date-time of the event" ip: type: "string" example: "165.87.3.15" description: "IP from which the user has opened the campaign" getContactCampaignStats_clicked: type: "object" required: - "campaignId" - "links" properties: campaignId: type: "integer" format: "int64" example: 3 description: "ID of the campaign which generated the event" links: type: "array" items: $ref: "#/definitions/getExtendedContactDetails_statistics_links" getContactCampaignStats_transacAttributes: type: "object" required: - "orderDate" - "orderId" - "orderPrice" properties: orderDate: type: "string" format: "date" example: "2017-03-12" description: "Date of the order" orderPrice: type: "number" format: "float" example: 24.99 description: "Price of the order" orderId: type: "integer" format: "int64" example: 248 description: "ID of the order" getAttributes_enumeration: type: "object" required: - "label" - "value" properties: value: type: "integer" format: "int64" example: 1 description: "ID of Value of the \"category\" type attribute" label: type: "string" example: "Women" description: "Label of the \"category\" type attribute" getAttributes_attributes: type: "object" required: - "category" - "name" properties: name: type: "string" example: "LASTNAME" description: "Name of the attribute" category: type: "string" example: "category" description: "Category of the attribute" enum: - "normal" - "transactional" - "category" - "calculated" - "global" type: type: "string" example: "text" description: "Type of the attribute" enum: - "text" - "date" - "float" - "id" - "boolean" enumeration: type: "array" description: "Parameter only available for \"category\" type attributes." items: $ref: "#/definitions/getAttributes_enumeration" calculatedValue: type: "string" example: "COUNT[ORDER_ID,ORDER_DATE,==,NOW(-1)]" description: "Calculated value formula" getSegments_segments: type: "object" properties: id: type: "integer" format: "int64" example: 23 description: "ID of the list" segmentName: type: "string" example: "My Segment" description: "Name of the Segment" categoryName: type: "string" format: "string" example: "New Category" description: "Name of the Segment Category" updatedAt: type: "string" example: "2017-03-13T17:05:09Z" description: "Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ)" getExtendedList_campaignStats: type: "object" required: - "campaignId" - "stats" properties: campaignId: type: "integer" format: "int64" example: 143 description: "ID of the campaign" stats: $ref: "#/definitions/getCampaignStats" updateSmtpTemplate_sender: type: "object" properties: name: type: "string" example: "Mary from MyShop" description: "Name of the sender" email: type: "string" format: "email" example: "contact@myshop.com" description: "Email of the sender" id: type: "integer" format: "int64" example: 3 description: "Select the sender for the template on the basis of sender id.\ \ In order to select a sender with specific pool of IP’s, dedicated ip users\ \ shall pass id (instead of email)." description: "Sender details including id or email and name (optional). Only one\ \ of either Sender's email or Sender's ID shall be passed in one request at\ \ a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` ,\ \ `{\"name\":\"xyz\", \"id\":123}`" createSmtpTemplate_sender: type: "object" properties: name: type: "string" example: "Mary from MyShop" description: "Name of the sender. If not passed, will be set to default" email: type: "string" format: "email" example: "contact@myshop.com" description: "Email of the sender" id: type: "integer" format: "int64" example: 3 description: "Select the sender for the template on the basis of sender id.\ \ In order to select a sender with specific pool of IP’s, dedicated ip users\ \ shall pass id (instead of email)." description: "Sender details including id or email and name (optional). Only one\ \ of either Sender's email or Sender's ID shall be passed in one request at\ \ a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` ,\ \ `{\"name\":\"xyz\", \"id\":123}`" createEmailCampaign_sender: type: "object" required: - "email" properties: name: type: "string" example: "Mary from MyShop" description: "Sender Name" email: type: "string" format: "email" example: "newsletter@myshop.com" description: "Sender email" id: type: "integer" format: "int64" example: 3 description: "Select the sender for the campaign on the basis of sender id.\ \ In order to select a sender with specific pool of IP’s, dedicated ip users\ \ shall pass id (instead of email)." description: "Sender details including id or email and name (optional). Only one\ \ of either Sender's email or Sender's ID shall be passed in one request at\ \ a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` ,\ \ `{\"name\":\"xyz\", \"id\":123}`" createEmailCampaign_recipients: type: "object" properties: exclusionListIds: type: "array" description: "List ids to exclude from the campaign" items: type: "integer" format: "int64" example: 8 listIds: type: "array" description: "Mandatory if scheduledAt is not empty. List Ids to send the\ \ campaign to" items: type: "integer" format: "int64" example: 32 segmentIds: type: "array" description: "Mandatory if listIds are not used. Segment ids to send the campaign\ \ to." items: type: "integer" format: "int64" example: 23 description: "Segment ids and List ids to include/exclude from campaign" updateEmailCampaign_sender: type: "object" properties: name: type: "string" example: "Mary from MyShop" description: "Sender Name from which the campaign emails are sent" email: type: "string" format: "email" example: "newsletter@myshop.com" description: "Sender email from which the campaign emails are sent" id: type: "integer" format: "int64" example: 3 description: "Select the sender for the campaign on the basis of sender id.\ \ In order to select a sender with specific pool of IP’s, dedicated ip users\ \ shall pass id (instead of email)." description: "Sender details including id or email and name (optional). Only one\ \ of either Sender's email or Sender's ID shall be passed in one request at\ \ a time. For example `{\"name\":\"xyz\", \"email\":\"example@abc.com\"}` ,\ \ `{\"name\":\"xyz\", \"id\":123}`" updateEmailCampaign_recipients: type: "object" properties: exclusionListIds: type: "array" description: "List ids which have to be excluded from a campaign" items: type: "integer" format: "int64" example: 8 listIds: type: "array" description: "Lists Ids to send the campaign to. Campaign should only be updated\ \ with listIds if listIds were used to create it. REQUIRED if already not\ \ present in campaign and scheduledAt is not empty" items: type: "integer" format: "int64" example: 32 segmentIds: type: "array" description: "Mandatory if listIds are not used. Campaign should only be updated\ \ with segmentIds if segmentIds were used to create it. Segment ids to send\ \ the campaign to." items: type: "integer" format: "int64" example: 23 description: "Segment ids and List ids to include/exclude from campaign" abTestCampaignResult_statistics: type: "object" required: - "clicks" - "complaints" - "hardBounces" - "openers" - "softBounces" - "unsubscribed" properties: openers: $ref: "#/definitions/abTestVersionStats" clicks: $ref: "#/definitions/abTestVersionStats" unsubscribed: $ref: "#/definitions/abTestVersionStats" hardBounces: $ref: "#/definitions/abTestVersionStats" softBounces: $ref: "#/definitions/abTestVersionStats" complaints: $ref: "#/definitions/abTestVersionStats" abTestCampaignResult_clickedLinks: type: "object" required: - "Version A" - "Version B" properties: Version A: $ref: "#/definitions/abTestVersionClicks" Version B: $ref: "#/definitions/abTestVersionClicks" sendReport_email: type: "object" required: - "body" - "to" properties: to: type: "array" description: "Email addresses of the recipients" items: type: "string" format: "email" example: "jim.suehan@example.com" description: "Email address of the recipient" body: type: "string" example: "Please find attached the report of our last email campaign." description: "Custom text message to be presented in the report email." description: "Custom attributes for the report email." sendSmtpEmail_sender: type: "object" properties: name: type: "string" example: "Mary from MyShop" description: "Name of the sender from which the emails will be sent. Maximum\ \ allowed characters are 70. Applicable only when email is passed." email: type: "string" format: "email" example: "no-reply@myshop.com" description: "Email of the sender from which the emails will be sent. Mandatory\ \ if sender id is not passed." id: type: "integer" format: "int64" example: 2 description: "Id of the sender from which the emails will be sent. In order\ \ to select a sender with specific pool of IP’s, dedicated ip users shall\ \ pass id (instead of email). Mandatory if email is not passed." description: "Mandatory if `templateId` is not passed. Pass `name` (optional)\ \ and `email` OR `id` of sender from which emails will be sent. `name` will\ \ be ignored if passed along with sender `id`. For example, {\"name\":\"Mary\ \ from MyShop\", \"email\":\"no-reply@myshop.com\"} or {\"id\":2}" sendSmtpEmail_to: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "jimmy98@example.com" description: "Email address of the recipient" name: type: "string" example: "Jimmy" description: "Name of the recipient. Maximum allowed characters are 70." sendSmtpEmail_bcc: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "helen9766@example.com" description: "Email address of the recipient in bcc" name: type: "string" example: "Helen" description: "Name of the recipient in bcc. Maximum allowed characters are\ \ 70." sendSmtpEmail_cc: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "ann6533@example.com" description: "Email address of the recipient in cc" name: type: "string" example: "Ann" description: "Name of the recipient in cc. Maximum allowed characters are\ \ 70." sendSmtpEmail_replyTo: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "ann6533@example.com" description: "Email address in reply to" name: type: "string" example: "Ann" description: "Name in reply to. Maximum allowed characters are 70." description: "Email (required), along with name (optional), on which transactional\ \ mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\"\ , \"name\":\"Ann\"}." sendSmtpEmail_attachment: type: "object" properties: url: type: "string" format: "url" example: "https://attachment.domain.com/myAttachmentFromUrl.jpg" description: "Absolute url of the attachment (no local file)." content: type: "string" format: "byte" example: "b3JkZXIucGRm" description: "Base64 encoded chunk data of the attachment generated on the\ \ fly" pattern: "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$" name: type: "string" example: "myAttachment.png" description: "Required if content is passed. Name of the attachment" sendSmtpEmail_to_1: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "jimmy98@example.com" description: "Email address of the recipient" name: type: "string" example: "Jimmy" description: "Name of the recipient. **Maximum allowed characters are 70**." sendSmtpEmail_replyTo_1: type: "object" required: - "email" properties: email: type: "string" format: "email" example: "ann6533@example.com" description: "Email address in reply to" name: type: "string" example: "Ann" description: "Name in reply to. Maximum allowed characters are 70." description: "Email (required), along with name (optional), on which transactional\ \ mail recipients will be able to reply back. For example, {\"email\":\"ann6533@example.com\"\ , \"name\":\"Ann\"}" sendSmtpEmail_messageVersions: type: "object" required: - "to" properties: to: type: "array" description: "List of email addresses and names (_optional_) of the recipients.\ \ For example, [{\"name\":\"Jimmy\", \"email\":\"jimmy98@example.com\"},\ \ {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]" items: $ref: "#/definitions/sendSmtpEmail_to_1" params: type: "object" example: FNAME: "Joe" LNAME: "Doe" description: "Pass the set of attributes to customize the template. For example,\ \ {\"FNAME\":\"Joe\", \"LNAME\":\"Doe\"}. It's considered only if template\ \ is in New Template Language format." additionalProperties: {} bcc: type: "array" description: "List of email addresses and names (optional) of the recipients\ \ in bcc" items: $ref: "#/definitions/sendSmtpEmail_bcc" cc: type: "array" description: "List of email addresses and names (optional) of the recipients\ \ in cc" items: $ref: "#/definitions/sendSmtpEmail_cc" replyTo: $ref: "#/definitions/sendSmtpEmail_replyTo_1" subject: type: "string" example: "Login Email confirmation" description: "Custom subject specific to message version\n" updateBatchContacts_contacts: type: "object" properties: email: type: "string" format: "email" example: "elly@example.com" description: "Email address of the user to be updated (For each operation\ \ only pass one of the supported contact identifiers. Email, id or sms)" id: type: "integer" format: "int64" example: 31 description: "id of the user to be updated (For each operation only pass one\ \ of the supported contact identifiers. Email, id or sms)" sms: type: "string" example: "+91xxxxxxxxxx" description: "SMS of the user to be updated (For each operation only pass\ \ one of the supported contact identifiers. Email, id or sms)" ext_id: type: "string" example: "UpdateExternalId" description: "Pass your own Id to update ext_id of a contact." attributes: type: "object" example: EMAIL: "newemail@domain.com" FNAME: "Ellie" LNAME: "Roger" description: "Pass the set of attributes to be updated. **These attributes\ \ must be present in your account**. To update existing email address of\ \ a contact with the new one please pass EMAIL in attribtes. For example,\ \ **{ \"EMAIL\":\"newemail@domain.com\", \"FNAME\":\"Ellie\", \"LNAME\"\ :\"Roger\"}**.\nKeep in mind transactional attributes can be updated the\ \ same way as normal attributes. Mobile Number in **SMS** field should be\ \ passed with proper country code. For example: **{\"SMS\":\"+91xxxxxxxxxx\"\ } or {\"SMS\":\"0091xxxxxxxxxx\"}**\n" additionalProperties: {} emailBlacklisted: type: "boolean" example: false description: "Set/unset this field to blacklist/allow the contact for emails\ \ (emailBlacklisted = true)" smsBlacklisted: type: "boolean" example: true description: "Set/unset this field to blacklist/allow the contact for SMS\ \ (smsBlacklisted = true)" listIds: type: "array" description: "Ids of the lists to add the contact to" items: type: "integer" format: "int64" example: 65 description: "Id of the list to add the contact to" unlinkListIds: type: "array" description: "Ids of the lists to remove the contact from" items: type: "integer" format: "int64" example: 36 description: "Id of the list to remove the contact from" smtpBlacklistSender: type: "array" description: "transactional email forbidden sender for contact. Use only for\ \ email Contact" items: type: "string" format: "email" createAttribute_enumeration: type: "object" required: - "label" - "value" properties: value: type: "integer" example: 1 description: "Id of the value" label: type: "string" example: "Women" description: "Label of the value" updateAttribute_enumeration: type: "object" required: - "label" - "value" properties: value: type: "integer" example: 1 description: "Id of the value" label: type: "string" example: "Men" description: "Label of the value" requestContactExport_customContactFilter: type: "object" properties: actionForContacts: type: "string" description: "Mandatory if neither actionForEmailCampaigns nor actionForSmsCampaigns\ \ is passed. This will export the contacts on the basis of provided action\ \ applied on contacts as per the list id. * allContacts - Fetch the list\ \ of all contacts for a particular list. * subscribed & unsubscribed - Fetch\ \ the list of subscribed / unsubscribed (blacklisted via any means) contacts\ \ for a particular list. * unsubscribedPerList - Fetch the list of contacts\ \ that are unsubscribed from a particular list only.\n" enum: - "allContacts" - "subscribed" - "unsubscribed" - "unsubscribedPerList" actionForEmailCampaigns: type: "string" description: "Mandatory if neither actionForContacts nor actionForSmsCampaigns\ \ is passed. This will export the contacts on the basis of provided action\ \ applied on email campaigns. * openers & nonOpeners - emailCampaignId is\ \ mandatory. Fetch the list of readers / non-readers for a particular email\ \ campaign. * clickers & nonClickers - emailCampaignId is mandatory. Fetch\ \ the list of clickers / non-clickers for a particular email campaign. *\ \ unsubscribed - emailCampaignId is mandatory. Fetch the list of all unsubscribed\ \ (blacklisted via any means) contacts for a particular email campaign.\ \ * hardBounces & softBounces - emailCampaignId is optional. Fetch the list\ \ of hard bounces / soft bounces for a particular / all email campaign(s).\n" enum: - "openers" - "nonOpeners" - "clickers" - "nonClickers" - "unsubscribed" - "hardBounces" - "softBounces" actionForSmsCampaigns: type: "string" description: "Mandatory if neither actionForContacts nor actionForEmailCampaigns\ \ is passed. This will export the contacts on the basis of provided action\ \ applied on sms campaigns. * unsubscribed - Fetch the list of all unsubscribed\ \ (blacklisted via any means) contacts for all / particular sms campaigns.\ \ * hardBounces & softBounces - Fetch the list of hard bounces / soft bounces\ \ for all / particular sms campaigns.\n" enum: - "hardBounces" - "softBounces" - "unsubscribed" listId: type: "integer" format: "int64" example: 2 description: "Mandatory if actionForContacts is passed, ignored otherwise.\ \ Id of the list for which the corresponding action shall be applied in\ \ the filter." emailCampaignId: type: "integer" format: "int64" example: 12 description: "Considered only if actionForEmailCampaigns is passed, ignored\ \ otherwise. Mandatory if action is one of the following - openers, nonOpeners,\ \ clickers, nonClickers, unsubscribed. The id of the email campaign for\ \ which the corresponding action shall be applied in the filter." smsCampaignId: type: "integer" format: "int64" example: 12 description: "Considered only if actionForSmsCampaigns is passed, ignored\ \ otherwise. The id of sms campaign for which the corresponding action shall\ \ be applied in the filter." description: "Set the filter for the contacts to be exported." requestContactImport_newList: type: "object" properties: listName: type: "string" example: "ContactImport - 2017-05" description: "List with listName will be created first and users will be imported\ \ in it (Mandatory if listIds is empty)." folderId: type: "integer" format: "int64" example: 2 description: "Id of the folder where this new list shall be created (Mandatory\ \ if listName is not empty)." description: "To create a new list and import the contacts into it, pass the listName\ \ and an optional folderId." createSmsCampaign_recipients: type: "object" required: - "listIds" properties: listIds: type: "array" description: "Lists Ids to send the campaign to. REQUIRED if scheduledAt is\ \ not empty" items: type: "integer" format: "int64" example: 54 description: "List Id to send the campaign to" exclusionListIds: type: "array" description: "List ids which have to be excluded from a campaign" items: type: "integer" format: "int64" example: 15 description: "List Id to exclude from the campaign" getTransacSmsReport_reports: type: "object" properties: date: type: "string" format: "date" example: "2017-03-17" description: "Date for which statistics are retrieved" requests: type: "integer" format: "int64" example: 87 description: "Number of requests for the date" delivered: type: "integer" format: "int64" example: 85 description: "Number of delivered SMS for the date" hardBounces: type: "integer" format: "int64" example: 1 description: "Number of hardbounces for the date" softBounces: type: "integer" format: "int64" example: 1 description: "Number of softbounces for the date" blocked: type: "integer" format: "int64" example: 0 description: "Number of blocked contact for the date" unsubscribed: type: "integer" format: "int64" example: 1 description: "Number of unsubscription for the date" replied: type: "integer" format: "int64" example: 2 description: "Number of answered SMS for the date" accepted: type: "integer" format: "int64" example: 85 description: "Number of accepted for the date" rejected: type: "integer" format: "int64" example: 1 description: "Number of rejected for the date" getTransacEmailContent_events: type: "object" required: - "name" - "time" properties: name: type: "string" example: "delivered" description: "Name of the event that occurred on the sent email" time: type: "string" example: "2017-03-12T12:30:00Z" description: "Time at which the event occurred" getTransacEmailsList_transactionalEmails: type: "object" required: - "date" - "email" - "messageId" - "subject" - "uuid" properties: email: type: "string" format: "email" example: "john.smith@example.com" description: "Email address to which transactional email has been sent" subject: type: "string" example: "Summer Camp" description: "Subject of the sent email" templateId: type: "integer" format: "int64" example: 2 description: "Id of the template" messageId: type: "string" example: "<201798300811.5700093@relay.domain.com>" description: "Message Id of the sent email" uuid: type: "string" example: "5a78c-209ok98262910-s99a341" description: "Unique id of the email sent to a particular contact" date: type: "string" example: "2017-03-12T12:30:00Z" description: "Date on which transactional email was sent" from: type: "string" format: "email" example: "diana.doe@example.com" description: "Email address of the sender from which the email was sent" tags: type: "array" description: "Tags used for your email" items: type: "string" example: "tag1" abTestVersionClicks_inner: type: "object" required: - "clickRate" - "clicksCount" - "link" properties: link: type: "string" example: "https://facbook.com/versionA" description: "URL of the link" clicksCount: type: "integer" format: "int64" example: 3 description: "Number of times a link is clicked" clickRate: type: "string" example: "40%" description: "Percentage of clicks of link with respect to total clicks" getInboundEmailEvents_events: type: "object" required: - "date" - "recipient" - "sender" - "uuid" properties: uuid: type: "string" format: "uuid" description: "UUID that can be used to fetch additional data" date: type: "string" format: "date-time" description: "Date when email was received on SMTP relay" sender: type: "string" format: "email" description: "Sender’s email address" recipient: type: "string" format: "email" description: "Recipient’s email address" getInboundEmailEventsByUuid_attachments: type: "object" properties: name: type: "string" description: "filename specified in the Content-Disposition header of the\ \ attachment" contentType: type: "string" description: "value of the Content-Type header of the attachment" contentId: type: "string" description: "value of the Content-ID header of the attachment." contentLength: type: "integer" description: "size of the attachment in bytes" getInboundEmailEventsByUuid_logs: type: "object" properties: date: type: "string" format: "date-time" description: "Date of the event" type: type: "string" description: "Type of the event" enum: - "received" - "processed" - "webhookFailed" - "webhookDelivered" getScheduledEmailByBatchId_batches: type: "object" required: - "createdAt" - "scheduledAt" - "status" properties: scheduledAt: type: "string" format: "date-time" description: "Datetime for which the batch was scheduled" createdAt: type: "string" format: "date-time" description: "Datetime on which the batch was scheduled" status: type: "string" description: "Current status of the scheduled batch" enum: - "inProgress" - "queued" - "processed" - "error" subAccountsResponse_subAccounts: type: "object" required: - "active" - "companyName" - "createdAt" - "id" properties: id: type: "integer" format: "int64" description: "id of the sub-account" companyName: type: "string" description: "Name of the sub-account company" active: type: "boolean" description: "Whether the sub-account is active or not" createdAt: type: "integer" format: "int64" description: "Timestamp when the sub-account was created" masterDetailsResponse_billingInfo_name: type: "object" properties: givenName: type: "string" description: "First name for billing" familyName: type: "string" description: "Last name for billing" description: "Billing name of master account holder" masterDetailsResponse_billingInfo_address: type: "object" properties: streetAddress: type: "string" description: "Street address" locality: type: "string" description: "Locality" postalCode: type: "string" description: "Postal code" stateCode: type: "string" description: "State code" countryCode: type: "string" description: "Country code" description: "Billing address of master account" masterDetailsResponse_billingInfo: type: "object" properties: email: type: "string" description: "Billing email id of master account" companyName: type: "string" description: "Company name of master account" name: $ref: "#/definitions/masterDetailsResponse_billingInfo_name" address: $ref: "#/definitions/masterDetailsResponse_billingInfo_address" description: "Billing details of the master account organization" masterDetailsResponse_planInfo_features: type: "object" properties: name: type: "string" description: "Name of the feature" unitValue: type: "string" description: "Unit value of the feature" quantity: type: "integer" format: "int64" description: "Quantity provided in the plan" used: type: "integer" format: "int64" description: "Quantity consumed by master" remaining: type: "integer" format: "int64" description: "Quantity remaining in the plan" masterDetailsResponse_planInfo: type: "object" properties: currencyCode: type: "string" description: "Plan currency" nextBillingAt: type: "integer" format: "int64" description: "Timestamp of next billing date" price: type: "number" description: "Plan amount" planPeriod: type: "string" description: "Plan period type" enum: - "month" - "year" subAccounts: type: "integer" description: "Number of sub-accounts" features: type: "array" description: "List of provided features in the plan" items: $ref: "#/definitions/masterDetailsResponse_planInfo_features" description: "Plan details" subAccountDetailsResponse_planInfo_credits_emails: type: "object" properties: quantity: type: "integer" format: "int64" description: "Quantity of email messaging limits provided" remaining: type: "integer" format: "int64" description: "Available email messaging limits for use" description: "Email credits remaining on the sub-account" subAccountDetailsResponse_planInfo_credits: type: "object" properties: sms: type: "integer" format: "int64" description: "SMS credits remaining on the sub-account" emails: $ref: "#/definitions/subAccountDetailsResponse_planInfo_credits_emails" description: "Credits quota and remaining credits on the sub-account" subAccountDetailsResponse_planInfo_features_inbox: type: "object" properties: quantity: type: "integer" format: "int64" description: "Quantity of inbox provided" remaining: type: "integer" format: "int64" description: "Available inboxes for use" description: "Inbox details" subAccountDetailsResponse_planInfo_features_landingPage: type: "object" properties: quantity: type: "integer" format: "int64" description: "Quantity of landing pages provided" remaining: type: "integer" format: "int64" description: "Available landing pages for use" description: "Landing page details" subAccountDetailsResponse_planInfo_features_users: type: "object" properties: quantity: type: "integer" format: "int64" description: "Quantity of multi-account's provided" remaining: type: "integer" format: "int64" description: "Available multi-accounts for use" description: "Multi-account details" subAccountDetailsResponse_planInfo_features: type: "object" properties: inbox: $ref: "#/definitions/subAccountDetailsResponse_planInfo_features_inbox" landingPage: $ref: "#/definitions/subAccountDetailsResponse_planInfo_features_landingPage" users: $ref: "#/definitions/subAccountDetailsResponse_planInfo_features_users" description: "Features available on the sub-account" subAccountDetailsResponse_planInfo: type: "object" properties: credits: $ref: "#/definitions/subAccountDetailsResponse_planInfo_credits" features: $ref: "#/definitions/subAccountDetailsResponse_planInfo_features" planType: type: "string" description: "type of the plan" description: "Sub-account plan details" subAccountUpdatePlanRequest_credits: type: "object" properties: email: type: "integer" format: "int64" description: "Number of email credits" description: "Credit details to update" subAccountUpdatePlanRequest_features: type: "object" properties: users: type: "integer" format: "int64" description: "Number of multi-users" landingPage: type: "integer" format: "int64" description: "Number of landing pages" inbox: type: "integer" format: "int64" description: "Number of inboxes" description: "Features details to update" DealAttributes_inner: type: "object" properties: internalName: type: "string" example: "deal_name" label: type: "string" example: "Deal Name" attributeTypeName: type: "string" example: "text" attributeOptions: type: "array" items: type: "object" example: key: "custom key" value: "custom label" properties: {} isRequired: type: "boolean" example: true description: "List of attributes" CompanyAttributes_inner: type: "object" properties: internalName: type: "string" example: "name" label: type: "string" example: "Company Name" attributeTypeName: type: "string" example: "text" attributeOptions: type: "array" items: type: "object" example: key: "custom key" value: "custom label" properties: {} isRequired: type: "boolean" example: true description: "List of attributes" ConversationsMessage_file_imageInfo: type: "object" properties: width: type: "integer" format: "int64" example: 1129 description: "Width of the image" minimum: 0 height: type: "integer" format: "int64" example: 525 description: "height of the image" minimum: 0 previewUrl: type: "string" format: "url" example: "https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/" description: "URL of the preview" description: "image info is passed in case the file is an image" example: previewUrl: "https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/" width: 1129 height: 525 ConversationsMessage_file: type: "object" properties: filename: type: "string" example: "conversations.png" description: "Name of the file" size: type: "integer" format: "int64" example: 15538 description: "Size in bytes" minimum: 0 isImage: type: "boolean" example: true description: "Whether the file is an image" url: type: "string" format: "url" example: "https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/" description: "URL of the file" imageInfo: $ref: "#/definitions/ConversationsMessage_file_imageInfo" example: isImage: true filename: "conversations.png" size: 15538 imageInfo: previewUrl: "https://ucarecdn.com/03cd56cd-1de9-4f65-996d-08afdf27fa1b/-/preview/800x800/-/quality/lighter/" width: 1129 height: 525 url: "https://ucarecdn.com/cee5c10c-8302-45c1-b1fb-43860ca941a9/" order_products: type: "object" required: - "price" - "productId" - "quantity" properties: productId: type: "string" example: "P1" description: "ID of the product." quantity: type: "number" example: 10.0 description: "How many pieces of the product the visitor has added to the\ \ cart." variantId: type: "string" example: "P100" description: "Product ID of the red color shirts." price: type: "number" example: 99.99 description: "The price of a unit of product" description: "Details for the Products in an order." order_billing: type: "object" properties: address: type: "string" example: "15 Somewhere Road, Brynmenyn" description: "Full billing address." city: type: "string" example: "Basel" description: "Exact city of the address." countryCode: type: "string" example: "CA" description: "Billing country 2-letter ISO code." phone: type: "string" example: "01559 032133" description: "Phone number to contact for further details about the order,\ \ Mandatory if \"email\" field is not passed." postCode: type: "string" example: "4052" description: "Postcode for delivery and billing." paymentMethod: type: "string" example: "PayPal" description: "How the visitor will pay for the item(s), e.g. paypal, check,\ \ etc." region: type: "string" example: "Northwestern Switzerland" description: "Exact region (state/province) for delivery and billing." description: "Billing details of an order." getWhatsappEventReport_events: type: "object" required: - "contactNumber" - "date" - "event" - "messageId" - "senderNumber" properties: contactNumber: type: "string" format: "mobile" example: "919876543210" description: "WhatsApp Number with country code. Example, 85264318721" date: type: "string" example: "2017-03-12T12:30:00.000+0000" description: "UTC date-time on which the event has been generated" messageId: type: "string" example: "23befbae-1505-47a8-bd27-e30ef739f32c" description: "Message ID which generated the event" event: type: "string" example: "delivered" description: "Event which occurred" enum: - "sent" - "delivered" - "read" - "error" - "unsubscribe" - "reply" - "soft-bounce" reason: type: "string" example: "23befbae-1505-47a8-bd27-e30ef739f32c" description: "Reason for the event (will be there in case of `error` and `soft-bounce`\ \ events)" body: type: "string" example: "Hi! I am a reply" description: "Text of the reply (will be there only in case of `reply` event\ \ with text)" mediaUrl: type: "string" format: "url" example: "https://example.com/media.png" description: "Url of the media reply (will be there only in case of `reply`\ \ event with media)" senderNumber: type: "string" format: "mobile" example: "919876543210" description: "WhatsApp Number with country code. Example, 85264318721" getExternalFeedByUUID_headers: type: "object" properties: name: type: "string" example: "userId" description: "Name of the header" value: type: "string" example: "user12345" description: "Value of the header" getAllExternalFeeds_feeds: type: "object" required: - "authType" - "cache" - "createdAt" - "headers" - "id" - "maxRetries" - "modifiedAt" - "name" - "url" properties: id: type: "string" format: "uuidv4" example: "54377442-20a2-4c20-b761-d636c72de7b7" description: "ID of the feed" name: type: "string" example: "New feed" description: "Name of the feed" url: type: "string" format: "url" example: "http://requestb.in/173lyyx1" description: "URL of the feed" authType: type: "string" description: "Auth type of the feed: * `basic` * `token` * `noAuth`\n" enum: - "basic" - "token" - "noAuth" username: type: "string" example: "user" description: "Username for authType `basic`" password: type: "string" example: "password" description: "Password for authType `basic`" token: type: "string" example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" description: "Token for authType `token`" headers: type: "array" description: "Custom headers for the feed" items: $ref: "#/definitions/getExternalFeedByUUID_headers" maxRetries: type: "integer" example: 5 description: "Maximum number of retries on the feed url" minimum: 0 maximum: 5 cache: type: "boolean" example: true description: "Toggle caching of feed url response" createdAt: type: "string" format: "date-time" example: "2022-10-06T05:03:47.053000000Z" description: "Datetime on which the feed was created" modifiedAt: type: "string" format: "date-time" example: "2022-10-06T05:03:47.053000000Z" description: "Datetime on which the feed was modified" x-samples-languages: - "curl"