getDomainsList
{
"type": "object",
"properties": {
"domains": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"domain_name",
"authenticated",
"verified"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Id of the domain"
},
"ip": {
"type": "string",
"example": "123.98.689.7",
"description": "Dedicated IP associated with domain"
},
"verified": {
"type": "boolean",
"example": false,
"description": "Status of domain verification (true=verified, false=non verified)"
},
"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)"
}
}
},
"description": "List of the domains available in your account"
}
}
}
getEmailCampaign
{
"allOf": [
{
"$ref": "#/components/schemas/getExtendedCampaignOverview"
},
{
"type": "object",
"required": [
"recipients",
"statistics"
],
"properties": {
"recipients": {
"$ref": "#/components/schemas/getCampaignRecipients"
},
"statistics": {
"$ref": "#/components/schemas/getExtendedCampaignStats"
}
},
"x-konfig-properties": {
"recipients": {
"type": "object"
},
"statistics": {
"type": "object"
}
}
}
]
}
getEmailCampaigns
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 24,
"description": "Number of Email campaigns retrieved"
},
"campaigns": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/getExtendedCampaignOverview"
},
{
"type": "object",
"required": [
"recipients",
"statistics"
],
"properties": {
"shareLink": {
"type": "string",
"format": "url",
"example": "http://dhh.brevo.com/fhsgccc.html?t=9865448900",
"description": "Link to share the campaign on social medias"
},
"recipients": {
"$ref": "#/components/schemas/getCampaignRecipients"
},
"statistics": {
"$ref": "#/components/schemas/getExtendedCampaignStats"
}
},
"x-konfig-properties": {
"recipients": {
"type": "object"
},
"statistics": {
"type": "object"
}
}
}
]
}
}
}
}
getEmailEventReport
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"required": [
"date",
"email",
"event",
"messageId"
],
"properties": {
"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)"
},
"tag": {
"type": "string",
"example": "OrderConfirmation",
"description": "Tag of the email which generated the event"
},
"date": {
"type": "string",
"example": "2017-03-12T12:30:00.000Z",
"description": "UTC date-time on which the event has been generated"
},
"from": {
"type": "string",
"format": "email",
"example": "john@example.com",
"description": "Sender email from which the emails are sent"
},
"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)"
},
"email": {
"type": "string",
"format": "email",
"example": "john.smith@example.com",
"description": "Email address which generates the event"
},
"event": {
"enum": [
"bounces",
"hardBounces",
"softBounces",
"delivered",
"spam",
"requests",
"opened",
"clicks",
"invalid",
"deferred",
"blocked",
"unsubscribed",
"error",
"loadedByProxy"
],
"type": "string",
"example": "delivered",
"description": "Event which occurred"
},
"reason": {
"type": "string",
"example": "Error connection timeout",
"description": "Reason of bounce (only available if the event is hardbounce or softbounce)"
},
"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"
},
"templateId": {
"type": "integer",
"format": "int64",
"example": 4,
"description": "ID of the template (only available if the email is template based)"
}
}
}
}
}
}
getExtendedCampaignOverview
{
"allOf": [
{
"$ref": "#/components/schemas/getCampaignOverview"
},
{
"type": "object",
"required": [
"createdAt",
"footer",
"header",
"htmlContent",
"modifiedAt",
"replyTo",
"sender",
"testSent"
],
"properties": {
"tag": {
"type": "string",
"example": "Newsletter",
"description": "Tag of the campaign"
},
"footer": {
"type": "string",
"example": "[DEFAULT_FOOTER]",
"description": "Footer of the campaign"
},
"header": {
"type": "string",
"example": "[DEFAULT_HEADER]",
"description": "Header of the campaign"
},
"sender": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 43,
"description": "Sender id of the campaign"
},
"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"
}
}
},
"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"
},
"sentDate": {
"type": "string",
"example": "2018-12-01T16:30:00.000Z",
"description": "Sent UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ). Only available if 'status' of the campaign is 'sent'"
},
"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)"
},
"createdAt": {
"type": "string",
"example": "2017-05-01T12:30:00.000Z",
"description": "Creation UTC date-time of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"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"
},
"shareLink": {
"type": "string",
"format": "url",
"example": "http://dhh.brevo.com/fhsgccc.html?t=9865448900",
"description": "Link to share the campaign on social medias"
},
"modifiedAt": {
"type": "string",
"example": "2017-05-01T12:30:00.000Z",
"description": "UTC date-time of last modification of the campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"htmlContent": {
"type": "string",
"example": "This is my HTML Content",
"description": "HTML content of the campaign"
},
"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"
},
"returnBounce": {
"type": "integer",
"format": "int64",
"example": 5,
"description": "Total number of non-delivered campaigns for a particular campaign id."
},
"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."
}
}
}
]
}
getExtendedCampaignStats
{
"type": "object",
"required": [
"campaignStats",
"globalStats",
"linksStats",
"mirrorClick",
"remaining",
"statsByBrowser",
"statsByDevice",
"statsByDomain"
],
"properties": {
"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
},
"properties": {},
"description": "Statistics about the number of clicks for the links"
},
"globalStats": {
"$ref": "#/components/schemas/getCampaignStats"
},
"mirrorClick": {
"type": "integer",
"format": "int64",
"example": 120,
"description": "Number of clicks on mirror link"
},
"campaignStats": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getCampaignStats"
},
"description": "List-wise statistics of the campaign."
},
"statsByDevice": {
"$ref": "#/components/schemas/getStatsByDevice"
},
"statsByDomain": {
"$ref": "#/components/schemas/getStatsByDomain"
},
"statsByBrowser": {
"$ref": "#/components/schemas/getStatsByBrowser"
}
},
"x-konfig-properties": {
"globalStats": {
"type": "object",
"description": "Overall statistics of the campaign"
}
}
}
getExtendedClient
{
"allOf": [
{
"$ref": "#/components/schemas/getClient"
},
{
"type": "object",
"required": [
"address"
],
"properties": {
"address": {
"type": "object",
"required": [
"city",
"country",
"street",
"zipCode"
],
"properties": {
"city": {
"type": "string",
"example": "New-York",
"description": "City information"
},
"street": {
"type": "string",
"example": "47 Harbour Street",
"description": "Street information"
},
"country": {
"type": "string",
"example": "United States of America",
"description": "Country information"
},
"zipCode": {
"type": "string",
"example": "9867",
"description": "Zip Code information"
}
},
"description": "Address informations"
}
}
}
]
}
getExtendedContactDetails
{
"allOf": [
{
"$ref": "#/components/schemas/getContactDetails"
},
{
"type": "object",
"required": [
"statistics"
],
"properties": {
"statistics": {
"type": "object",
"properties": {
"opened": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"count",
"eventTime",
"ip"
],
"properties": {
"ip": {
"type": "string",
"example": "165.87.3.15",
"description": "IP from which the user has opened the email"
},
"count": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Number of openings for the campaign"
},
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the openings generated by the contact"
},
"clicked": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"links"
],
"properties": {
"links": {
"type": "array",
"items": {
"type": "object",
"required": [
"count",
"eventTime",
"ip",
"url"
],
"properties": {
"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"
},
"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:13.000Z",
"description": "UTC date-time of the event"
}
}
},
"description": "Listing of the clicked links for the campaign"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the clicks generated by the contact"
},
"delivered": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the delivered campaign for the contact"
},
"complaints": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the complaints generated by the contact"
},
"hardBounces": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the hardbounes generated by the contact"
},
"softBounces": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the softbounes generated by the contact"
},
"messagesSent": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Listing of the sent campaign for the contact"
},
"unsubscriptions": {
"type": "object",
"required": [
"adminUnsubscription",
"userUnsubscription"
],
"properties": {
"userUnsubscription": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"eventTime"
],
"properties": {
"ip": {
"type": "string",
"example": "165.87.3.15",
"description": "IP from which the user has unsubscribed"
},
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "ID of the campaign which generated the event"
}
}
},
"description": "Contact unsubscribe via unsubscription link in a campaign"
},
"adminUnsubscription": {
"type": "array",
"items": {
"type": "object",
"required": [
"eventTime"
],
"properties": {
"ip": {
"type": "string",
"example": "165.87.3.15",
"description": "IP from which the user has been unsubscribed"
},
"eventTime": {
"type": "string",
"example": "2017-03-12T20:15:13.000Z",
"description": "UTC date-time of the event"
}
}
},
"description": "Contact has been unsubscribed from the administrator"
}
},
"description": "Listing of the unsubscription for the contact"
},
"transacAttributes": {
"type": "array",
"items": {
"type": "object",
"properties": {}
},
"description": "Listing of the transactional attributes for the contact"
}
},
"description": "Campaign statistics of the contact"
}
}
}
]
}
getExtendedList
{
"allOf": [
{
"$ref": "#/components/schemas/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:09.000Z",
"description": "Creation UTC date-time of the list (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"dynamicList": {
"type": "boolean",
"example": false,
"description": "Status telling if the list is dynamic or not (true=dynamic, false=not dynamic)"
},
"campaignStats": {
"type": "array",
"items": {
"type": "object",
"required": [
"campaignId",
"stats"
],
"properties": {
"stats": {
"$ref": "#/components/schemas/getCampaignStats"
},
"campaignId": {
"type": "integer",
"format": "int64",
"example": 143,
"description": "ID of the campaign"
}
}
}
}
}
}
]
}
getExternalFeedByUUID
{
"type": "object",
"required": [
"id",
"name",
"url",
"authType",
"headers",
"maxRetries",
"cache",
"createdAt",
"modifiedAt"
],
"properties": {
"id": {
"type": "string",
"format": "uuidv4",
"example": "54377442-20a2-4c20-b761-d636c72de7b7",
"description": "ID of the feed"
},
"url": {
"type": "string",
"format": "url",
"example": "http://requestb.in/173lyyx1",
"description": "URL of the feed"
},
"name": {
"type": "string",
"example": "New feed",
"description": "Name of the feed"
},
"cache": {
"type": "boolean",
"example": true,
"description": "Toggle caching of feed url response"
},
"token": {
"type": "string",
"example": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
"description": "Token for authType `token`"
},
"headers": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"example": "userId",
"description": "Name of the header"
},
"value": {
"type": "string",
"example": "user12345",
"description": "Value of the header"
}
}
},
"description": "Custom headers for the feed"
},
"authType": {
"enum": [
"basic",
"token",
"noAuth"
],
"type": "string",
"description": "Auth type of the feed: * `basic` * `token` * `noAuth`\n"
},
"password": {
"type": "string",
"example": "password",
"description": "Password for authType `basic`"
},
"username": {
"type": "string",
"example": "user",
"description": "Username for authType `basic`"
},
"createdAt": {
"type": "string",
"format": "date-time",
"example": "2022-10-06T05:03:47.053000000Z",
"description": "Datetime on which the feed was created"
},
"maxRetries": {
"type": "integer",
"default": 5,
"example": 5,
"maximum": 5,
"minimum": 0,
"description": "Maximum number of retries on the feed url"
},
"modifiedAt": {
"type": "string",
"format": "date-time",
"example": "2022-10-06T05:03:47.053000000Z",
"description": "Datetime on which the feed was modified"
}
}
}
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": {
"count": {
"type": "integer",
"format": "int64",
"example": 6,
"description": "Number of lists in the folder"
},
"lists": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getList"
}
}
}
}
getFolders
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 10,
"description": "Number of folders available in your account"
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getFolder"
}
}
}
}
getInboundEmailEvents
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"required": [
"uuid",
"sender",
"date",
"recipient"
],
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date when email was received on SMTP relay"
},
"uuid": {
"type": "string",
"format": "uuid",
"description": "UUID that can be used to fetch additional data"
},
"sender": {
"type": "string",
"format": "email",
"description": "Sender’s email address"
},
"recipient": {
"type": "string",
"format": "email",
"description": "Recipient’s email address"
}
}
}
}
}
}
getInboundEmailEventsByUuid
{
"type": "object",
"properties": {
"logs": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date-time",
"description": "Date of the event"
},
"type": {
"enum": [
"received",
"processed",
"webhookFailed",
"webhookDelivered"
],
"type": "string",
"description": "Type of the event"
}
}
},
"description": "List of events/logs that describe the lifecycle of the email on SIB platform"
},
"sender": {
"type": "string",
"format": "email",
"description": "Sender’s email address"
},
"subject": {
"type": "string",
"description": "Value of the Subject header. This will be present only after the processing is done. "
},
"messageId": {
"type": "string",
"description": "Value of the Message-ID header. This will be present only after the processing is done."
},
"recipient": {
"type": "string",
"format": "email",
"description": "Recipient’s email address"
},
"receivedAt": {
"type": "string",
"format": "date-time",
"example": "2019-05-25T11:53:26Z",
"description": "Date when email was received on SMTP relay"
},
"attachments": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "filename specified in the Content-Disposition header of the attachment"
},
"contentId": {
"type": "string",
"description": "value of the Content-ID header of the attachment."
},
"contentType": {
"type": "string",
"description": "value of the Content-Type header of the attachment"
},
"contentLength": {
"type": "integer",
"description": "size of the attachment in bytes"
}
}
},
"description": "List of attachments of the email. This will be present only after the processing is done."
},
"deliveredAt": {
"type": "string",
"format": "date-time",
"nullable": true,
"description": "Date when email was delivered successfully to client’s webhook"
}
}
}
getInvitedUsersList
{
"type": "object",
"properties": {
"users": {
"type": "array",
"items": {
"type": "object",
"required": [
"email",
"is_owner",
"status",
"feature_access"
],
"properties": {
"email": {
"type": "string",
"example": "pendingInvitedUser@company.com",
"description": "Email address of the user."
},
"status": {
"type": "string",
"example": "active",
"description": "Status of the invited user."
},
"is_owner": {
"type": "string",
"example": true,
"description": "Flag for indicating is user owner of the organization."
},
"feature_access": {
"type": "object",
"properties": {
"crm": {
"type": "string",
"example": "full",
"description": "CRM features accessiblity."
},
"marketing": {
"type": "string",
"example": "custom",
"description": "Marketing features accessiblity."
},
"conversations": {
"type": "string",
"example": "none",
"description": "Conversations features accessiblity."
}
},
"description": "Feature accessiblity given to the user."
}
}
},
"description": "Get invited users list"
}
}
}
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"
}
}
}
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"
}
}
}
getIps
{
"type": "object",
"required": [
"ips"
],
"properties": {
"ips": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getIp"
},
"description": "Dedicated IP(s) available on your account"
}
}
}
getIpsFromSender
{
"type": "object",
"required": [
"ips"
],
"properties": {
"ips": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getIpFromSender"
},
"description": "Dedicated IP(s) linked to a sender"
}
}
}
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"
}
}
}
getLists
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 150,
"description": "Number of lists in your account"
},
"lists": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/getList"
},
{
"type": "object",
"required": [
"folderId"
],
"properties": {
"folderId": {
"type": "integer",
"format": "int64",
"example": 2,
"description": "ID of the folder"
}
}
}
]
},
"description": "Listing of all the lists available in your account"
}
}
}
getPaymentRequest
{
"type": "object",
"required": [
"reference",
"status",
"cart",
"notification"
],
"properties": {
"cart": {
"$ref": "#/components/schemas/cart"
},
"status": {
"enum": [
"created",
"sent",
"reminderSent",
"paid"
],
"type": "string",
"example": "paid",
"description": "Status of the payment request."
},
"contactId": {
"type": "integer",
"format": "int64",
"example": 43,
"description": "Brevo ID of the contact requested to pay.\n"
},
"reference": {
"type": "string",
"example": "Invoice #INV0001\n",
"description": "Reference of the payment request, it will appear on the payment page.\n"
},
"notification": {
"$ref": "#/components/schemas/notification"
},
"configuration": {
"$ref": "#/components/schemas/configuration"
}
}
}
getProcess
{
"type": "object",
"required": [
"id",
"name",
"status"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 145,
"description": "Id of the process"
},
"name": {
"type": "string",
"example": "IMPORTUSER",
"description": "Process name"
},
"status": {
"enum": [
"queued",
"in_process",
"completed"
],
"type": "string",
"example": "queued",
"description": "Status of the process"
},
"export_url": {
"type": "string",
"example": "http://requestb.in/16ua3aj1",
"description": "URL on which send export the of contacts once the process is completed"
}
}
}
getProcesses
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 5,
"description": "Number of processes available on your account"
},
"processes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getProcess"
},
"description": "List of processes available on your account"
}
}
}
getProductDetails
{
"type": "object",
"required": [
"id",
"name",
"createdAt",
"modifiedAt",
"s3ThumbAnalytics",
"s3ThumbEditor"
],
"properties": {
"id": {
"type": "string",
"format": "string",
"example": "P11",
"description": "Product ID for which you requested the details"
},
"sku": {
"type": "string",
"format": "string",
"description": "Product identifier from the shop"
},
"url": {
"type": "string",
"format": "string",
"example": "http://mydomain.com/product/electronics/product1",
"description": "URL to the product"
},
"name": {
"type": "string",
"format": "string",
"example": "Iphone 11",
"description": "Name of the product for which you requested the details"
},
"price": {
"type": "number",
"format": "float",
"description": "Price of 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"
},
"metaInfo": {
"type": "object",
"example": {
"brand": "addidas",
"description": "Shoes for sports"
},
"description": "Meta data of product such as description, vendor, producer, stock level, etc."
},
"parentId": {
"type": "string",
"format": "string",
"description": "Parent product id of the product"
},
"createdAt": {
"type": "string",
"example": "2017-05-12T12:30:00.000Z",
"description": "Creation UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"isDeleted": {
"type": "boolean",
"example": true,
"description": "product deleted from the shop's database"
},
"categories": {
"type": "array",
"items": {
"type": "string"
},
"description": "Category ID-s of the product"
},
"modifiedAt": {
"type": "string",
"example": "2017-05-12T12:30:00.000Z",
"description": "Last modification UTC date-time of the product (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"s3Original": {
"type": "string",
"format": "string",
"description": "S3 url of original image"
},
"s3ThumbEditor": {
"type": "string",
"format": "string",
"description": "S3 thumbnail url of original image in 600x400 dimension for editor section"
},
"s3ThumbAnalytics": {
"type": "string",
"format": "string",
"description": "S3 thumbnail url of original image in 120x120 dimension for analytics section"
}
}
}
getProducts
{
"type": "object",
"required": [
"products",
"count"
],
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 17655,
"description": "Number of products"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getProductDetails"
}
}
}
}
getReports
{
"type": "object",
"properties": {
"reports": {
"type": "array",
"items": {
"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-06T00:00:00.000Z",
"description": "Date of the statistics"
},
"opens": {
"type": "integer",
"format": "int64",
"example": 58,
"description": "Number of openings for the date"
},
"clicks": {
"type": "integer",
"format": "int64",
"example": 6,
"description": "Number of clicks 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"
},
"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"
},
"spamReports": {
"type": "integer",
"format": "int64",
"example": 0,
"description": "Number of complaints (spam reports) for the date"
},
"uniqueOpens": {
"type": "integer",
"format": "int64",
"example": 52,
"description": "Number of unique openings for the date"
},
"uniqueClicks": {
"type": "integer",
"format": "int64",
"example": 5,
"description": "Number of unique clicks for the date"
},
"unsubscribed": {
"type": "integer",
"format": "int64",
"example": 0,
"description": "Number of unsubscribed emails for the date"
}
}
}
}
}
}
getScheduledEmailByBatchId
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"description": "Total number of batches"
},
"batches": {
"type": "array",
"items": {
"type": "object",
"required": [
"scheduledAt",
"createdAt",
"status"
],
"properties": {
"status": {
"enum": [
"inProgress",
"queued",
"processed",
"error"
],
"type": "string",
"description": "Current status of the scheduled batch"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime on which the batch was scheduled"
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Datetime for which the batch was scheduled"
}
}
}
}
}
}
getScheduledEmailByMessageId
{
"type": "object",
"required": [
"scheduledAt",
"createdAt",
"status"
],
"properties": {
"status": {
"enum": [
"inProgress",
"queued",
"processed",
"error"
],
"type": "string",
"description": "Current status of the scheduled email"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Datetime on which the email was scheduled"
},
"scheduledAt": {
"type": "string",
"format": "date-time",
"description": "Datetime for which the email was scheduled"
}
}
}
getSegments
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 10,
"description": "Number of Segments in your account"
},
"segments": {
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"segmentName",
"categoryName"
]
},
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 23,
"description": "ID of the list"
},
"updatedAt": {
"type": "string",
"example": "2017-03-13T17:05:09Z",
"description": "Updation UTC date-time of the segment (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"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"
}
},
"description": "Listing of all the segments available in your account"
}
}
}
getSendersList
{
"type": "object",
"properties": {
"senders": {
"type": "array",
"items": {
"type": "object",
"required": [
"active",
"email",
"id",
"name"
],
"properties": {
"id": {
"type": "integer",
"format": "int64",
"example": 0,
"description": "Id of the sender"
},
"ips": {
"type": "array",
"items": {
"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"
}
}
},
"description": "List of dedicated IP(s) available in the account. This data is displayed only for dedicated IPs"
},
"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)"
}
}
},
"description": "List of the senders available in your account"
}
}
}
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."
}
}
}
getSmsCampaign
{
"allOf": [
{
"$ref": "#/components/schemas/getSmsCampaignOverview"
},
{
"type": "object",
"required": [
"recipients",
"statistics"
],
"properties": {
"recipients": {
"$ref": "#/components/schemas/getCampaignRecipients"
},
"statistics": {
"$ref": "#/components/schemas/getSmsCampaignStats"
}
},
"x-konfig-properties": {
"recipients": {
"type": "object"
},
"statistics": {
"type": "object"
}
}
}
]
}
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"
},
"sender": {
"type": "string",
"example": "MyCompany",
"description": "Sender of the SMS Campaign"
},
"status": {
"enum": [
"draft",
"sent",
"archive",
"queued",
"suspended",
"inProcess"
],
"type": "string",
"example": "draft",
"description": "Status of the SMS Campaign"
},
"content": {
"type": "string",
"example": "Visit our Store and get some discount !",
"description": "Content of the SMS Campaign"
},
"createdAt": {
"type": "string",
"example": "2017-06-01T12:30:00.000Z",
"description": "Creation UTC date-time of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"modifiedAt": {
"type": "string",
"example": "2017-05-01T12:30:00.000Z",
"description": "UTC date-time of last modification of the SMS campaign (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"scheduledAt": {
"type": "string",
"example": "2017-06-01T12:30:00.000Z",
"description": "UTC date-time on which SMS campaign is scheduled. Should be in YYYY-MM-DDTHH:mm:ss.SSSZ format"
}
}
}
getSmsCampaignStats
{
"type": "object",
"required": [
"answered",
"delivered",
"hardBounces",
"processing",
"sent",
"softBounces",
"unsubscriptions"
],
"properties": {
"sent": {
"type": "integer",
"format": "int64",
"example": 3000,
"description": "Number of sent SMS"
},
"answered": {
"type": "integer",
"format": "int64",
"example": 2,
"description": "Number of replies to the SMS"
},
"delivered": {
"type": "integer",
"format": "int64",
"example": 2987,
"description": "Number of delivered SMS"
},
"processing": {
"type": "integer",
"format": "int64",
"example": 0,
"description": "Number of processing SMS"
},
"hardBounces": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Number of hardbounced SMS"
},
"softBounces": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "Number of softbounced SMS"
},
"unsubscriptions": {
"type": "integer",
"format": "int64",
"example": 3,
"description": "Number of unsubscription SMS"
}
}
}
getSmsCampaigns
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 12,
"description": "Number of SMS campaigns retrieved"
},
"campaigns": {
"type": "array",
"items": {
"type": "object",
"allOf": [
{
"$ref": "#/components/schemas/getSmsCampaignOverview"
},
{
"type": "object",
"required": [
"recipients",
"statistics"
],
"properties": {
"recipients": {
"$ref": "#/components/schemas/getCampaignRecipients"
},
"statistics": {
"$ref": "#/components/schemas/getSmsCampaignStats"
}
},
"x-konfig-properties": {
"recipients": {
"type": "object"
},
"statistics": {
"type": "object"
}
}
}
]
}
}
}
}
getSmsEventReport
{
"type": "object",
"properties": {
"events": {
"type": "array",
"items": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"example": "CabWaiting",
"description": "Tag of the SMS which generated the event"
},
"date": {
"type": "string",
"example": "2017-03-12T12:30:00.000Z",
"description": "UTC date-time on which the event has been generated"
},
"event": {
"enum": [
"bounces",
"hardBounces",
"softBounces",
"delivered",
"sent",
"accepted",
"unsubscription",
"replies",
"blocked",
"rejected"
],
"type": "string",
"example": "accepted",
"description": "Event which occurred"
},
"reply": {
"type": "string"
},
"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)"
},
"messageId": {
"type": "string",
"example": "1472640582425378",
"description": "Message ID which generated the event"
},
"phoneNumber": {
"type": "string",
"example": "00189001094",
"description": "Phone number which has generated the event"
}
}
}
}
}
}
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"
},
"tag": {
"type": "string",
"example": "sports",
"description": "Tag of the template"
},
"name": {
"type": "string",
"example": "Order Confirmation - EN",
"description": "Name of the template"
},
"sender": {
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "43",
"description": "Sender id of the template"
},
"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"
}
}
},
"replyTo": {
"type": "string",
"format": "email",
"example": "replyto@domain.com",
"description": "Email defined as the \"Reply to\" for the template"
},
"subject": {
"type": "string",
"example": "Thanks for your order !",
"description": "Subject of the template"
},
"toField": {
"type": "string",
"example": "{FIRSTNAME} {LASTNAME}",
"description": "Customisation of the \"to\" field for 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)"
},
"createdAt": {
"type": "string",
"example": "2017-05-01T12:30:00.000Z",
"description": "Creation UTC date-time of the template (YYYY-MM-DDTHH:mm:ss.SSSZ)"
},
"modifiedAt": {
"type": "string",
"example": "2017-05-12T12:30:00.000Z",
"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."
},
"htmlContent": {
"type": "string",
"example": "Your order n°xxxxx has been confirmed. Thanks for your purchase.",
"description": "HTML content of the template"
}
}
}
getSmtpTemplates
{
"type": "object",
"properties": {
"count": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Count of transactional email templates"
},
"templates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/getSmtpTemplateOverview"
}
}
}
}
getSsoToken
{
"type": "object",
"required": [
"token"
],
"properties": {
"token": {
"type": "string",
"example": "ede520dxxxxxxxxxxxx76d631fba2",
"description": "Session token, it will remain valid for 15 days."
}
}
}
getStatsByBrowser
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/getDeviceBrowserStats"
}
}
getStatsByDevice
{
"type": "object",
"properties": {
"mobile": {
"type": "object",
"description": "Statistics of the campaign on the basis of mobile devices",
"additionalProperties": {
"$ref": "#/components/schemas/getDeviceBrowserStats"
}
},
"tablet": {
"type": "object",
"description": "Statistics of the campaign on the basis of tablet devices",
"additionalProperties": {
"$ref": "#/components/schemas/getDeviceBrowserStats"
}
},
"desktop": {
"type": "object",
"description": "Statistics of the campaign on the basis of desktop devices",
"additionalProperties": {
"$ref": "#/components/schemas/getDeviceBrowserStats"
}
},
"unknown": {
"type": "object",
"description": "Statistics of the campaign on the basis of unknown devices",
"additionalProperties": {
"$ref": "#/components/schemas/getDeviceBrowserStats"
}
}
}
}
getStatsByDomain
{
"type": "object",
"additionalProperties": {
"$ref": "#/components/schemas/getCampaignStats"
}
}
getTransacAggregatedSmsReport
{
"type": "object",
"properties": {
"range": {
"type": "string",
"example": "2016-09-08|2017-04-06",
"description": "Time frame of the report"
},
"blocked": {
"type": "integer",
"format": "int64",
"example": 2,
"description": "Number of blocked contact 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"
},
"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"
},
"unsubscribed": {
"type": "integer",
"format": "int64",
"example": 6,
"description": "Number of unsubscription 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": {
"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"
},
"reason": {
"type": "object",
"example": "Admin blocked",
"properties": {
"code": {
"enum": [
"unsubscribedViaMA",
"unsubscribedViaEmail",
"adminBlocked",
"unsubscribedViaApi",
"hardBounce",
"contactFlaggedAsSpam"
],
"type": "string",
"example": "AdminBlocked",
"description": "Reason code for blocking / unsubscribing (This code is safe for comparison)"
},
"message": {
"type": "string",
"example": "Admin blocked",
"description": "Reason for blocking / unsubscribing (This string is not safe for comparison)"
}
},
"description": "Reason for blocking / unsubscribing"
},
"blockedAt": {
"type": "string",
"example": "2017-05-01T12:30:00.000Z",
"description": "Date when the contact was blocked or unsubscribed on"
},
"senderEmail": {
"type": "string",
"format": "email",
"example": "john.smith@example.com",
"description": "Sender email address of the blocked or unsubscribed contact"
}
}
}
}
}
}
getTransacEmailContent
{
"type": "object",
"required": [
"attachmentCount",
"body",
"date",
"email",
"events",
"subject"
],
"properties": {
"body": {
"type": "string",
"example": "<!DOCTYPE html> <html> <body> <h1>Greetings from the team</h1> <p>This is the actual html content sent</p> </body> </html>",
"description": "Actual content of the transactional email that has been sent"
},
"date": {
"type": "string",
"example": "2017-03-12T12:30:00.000Z",
"description": "Date on which transactional email was sent"
},
"email": {
"type": "string",
"format": "email",
"example": "abc@example.com",
"description": "Email address to which transactional email has been sent"
},
"events": {
"type": "array",
"items": {
"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:00.000Z",
"description": "Time at which the event occurred"
}
}
},
"description": "Series of events which occurred on the transactional email"
},
"subject": {
"type": "string",
"example": "Summer Camp",
"description": "Subject of the sent email"
},
"templateId": {
"type": "integer",
"format": "int64",
"example": 2,
"description": "Id of the template"
},
"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": {
"type": "object",
"required": [
"date",
"email",
"messageId",
"subject",
"uuid"
],
"properties": {
"date": {
"type": "string",
"example": "2017-03-12T12:30:00.000Z",
"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",
"items": {
"type": "string",
"example": "tag1"
},
"description": "Tags used for your email"
},
"uuid": {
"type": "string",
"example": "5a78c-209ok98262910-s99a341",
"description": "Unique id of the email sent to a particular contact"
},
"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"
},
"messageId": {
"type": "string",
"example": "<201798300811.5700093@relay.domain.com>",
"description": "Message Id of the sent email"
},
"templateId": {
"type": "integer",
"format": "int64",
"example": 2,
"description": "Id of the template"
}
}
}
}
}
}
getTransacSmsReport
{
"type": "object",
"properties": {
"reports": {
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"format": "date",
"example": "2017-03-17T00:00:00.000Z",
"description": "Date for which statistics are retrieved"
},
"blocked": {
"type": "integer",
"format": "int64",
"example": 0,
"description": "Number of blocked contact 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"
},
"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"
},
"unsubscribed": {
"type": "integer",
"format": "int64",
"example": 1,
"description": "Number of unsubscription for the date"
}
}
}
}
}
}
getUserPermission
{
"type": "object",
"required": [
"email",
"status",
"privileges"
],
"properties": {
"email": {
"type": "string",
"example": "invitedUser@company.com",
"description": "Email address of the user."
},
"status": {
"type": "string",
"example": "active",
"description": "Status of the invited user."
},
"privileges": {
"type": "array",
"items": {
"type": "object",
"required": [
"feature",
"permissions"
],
"properties": {
"feature": {
"type": "string",
"example": "Email campaign"
},
"permissions": {
"type": "array",
"items": {
"type": "string",
"example": "Create / edit / delete"
}
}
}
},
"description": "Granular feature permissions given to the user."
}
},
"description": "Check user permission"
}