Please confirm your email address by clicking on the link below
","type":"string"},"messageVersions":{"description":"Array of message version objects for sending customized email variants. The `templateId` can be customized per version only if a global `templateId` is provided. The `htmlContent` and `textContent` can be customized per version only if at least one of these is present in the global parameters. Global parameters such as `to` (required), `bcc`, `cc`, `replyTo`, and `subject` can be customized per version. Maximum total recipients per API request is 2000. Maximum recipients per message version is 99. Individual `params` objects must not exceed 100 KB. Cumulative `params` across all versions must not exceed 1000 KB. See https://developers.brevo.com/docs/batch-send-transactional-emails for detailed usage instructions.\n","items":{"properties":{"bcc":{"description":"Array of BCC recipient objects. Each object contains an email address and an optional name.\n","items":{"properties":{"contactPixelTrackingConsent":{"description":"Consent of the recipient in bcc for open (pixel) and click tracking, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass `true` if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Pass `false` to anonymise the open and click events (counted in aggregate statistics only). If it is not passed, the recipient is treated as unknown consent status and the email is still sent (the open and click are anonymised unless your account tracks unknown-consent contacts). A value other than `true`/`false` is rejected. Ignored when the feature is not enabled for your account.\n","example":true,"type":"boolean"},"email":{"description":"BCC recipient email address","example":"helen9766@example.com","format":"email","type":"string"},"name":{"description":"Display name of the BCC recipient. Maximum length is 70 characters.\n","example":"Helen","type":"string"}},"required":["email"],"type":"object"},"type":"array"},"cc":{"description":"Array of CC recipient objects. Each object contains an email address and an optional name.\n","items":{"properties":{"contactPixelTrackingConsent":{"description":"Consent of the recipient in cc for open (pixel) and click tracking, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass `true` if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Pass `false` to anonymise the open and click events (counted in aggregate statistics only). If it is not passed, the recipient is treated as unknown consent status and the email is still sent (the open and click are anonymised unless your account tracks unknown-consent contacts). A value other than `true`/`false` is rejected. Ignored when the feature is not enabled for your account.\n","example":true,"type":"boolean"},"email":{"description":"CC recipient email address","example":"ann6533@example.com","format":"email","type":"string"},"name":{"description":"Display name of the CC recipient. Maximum length is 70 characters.\n","example":"Ann","type":"string"}},"required":["email"],"type":"object"},"type":"array"},"htmlContent":{"description":"HTML body content of the email. Required when `templateId` is not provided. Ignored when `templateId` is provided.\n","example":"Please confirm your email address by clicking on the link below
","type":"string"},"params":{"additionalProperties":{},"description":"Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.\n","example":{"FNAME":"Joe","LNAME":"Doe"},"type":"object"},"replyTo":{"description":"Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.\n","properties":{"email":{"description":"Email address in reply to","example":"ann6533@example.com","format":"email","type":"string"},"name":{"description":"Display name for the reply-to address. Maximum length is 70 characters.\n","example":"Ann","type":"string"}},"required":["email"],"type":"object"},"subject":{"description":"Email subject line for this message version\n","example":"Login Email confirmation","type":"string"},"textContent":{"description":"Plain text body content of the email. Ignored when `templateId` is provided.\n","example":"Please confirm your email address by clicking on the link https://text.domain.com","type":"string"},"to":{"description":"Array of recipient objects. Each object contains an email address and an optional display name.\n","items":{"properties":{"contactPixelTrackingConsent":{"description":"Consent of the recipient for open (pixel) and click tracking, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass `true` if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Pass `false` to anonymise the open and click events (counted in aggregate statistics only). If it is not passed, the recipient is treated as unknown consent status and the email is still sent (the open and click are anonymised unless your account tracks unknown-consent contacts). A value other than `true`/`false` is rejected. Ignored when the feature is not enabled for your account.\n","example":true,"type":"boolean"},"email":{"description":"Email address of the recipient","example":"jimmy98@example.com","format":"email","type":"string"},"name":{"description":"Display name of the recipient. Maximum length is 70 characters.\n","example":"Jimmy","type":"string"}},"required":["email"],"type":"object"},"type":"array"}},"required":["to"],"type":"object"},"type":"array"},"params":{"additionalProperties":{},"description":"Key-value pairs for template variable substitution. Only applicable when the template uses the New Template Language format.\n","example":{"FNAME":"Joe","LNAME":"Doe"},"type":"object"},"replyTo":{"description":"Reply-to email address (required) and optional display name. Recipients will use this address when replying to the email.\n","properties":{"email":{"description":"Email address in reply to","example":"ann6533@example.com","format":"email","type":"string"},"name":{"description":"Display name for the reply-to address. Maximum length is 70 characters.\n","example":"Ann","type":"string"}},"required":["email"],"type":"object"},"scheduledAt":{"description":"UTC date-time when the email should be sent (format: YYYY-MM-DDTHH:mm:ss.SSSZ). Include timezone information in the date-time value. Scheduled emails may be delayed by up to 5 minutes.","example":"2022-04-05T12:30:00+02:00","format":"date-time","type":"string"},"sender":{"description":"Sender information. Required when `templateId` is not provided. Specify either an email address (with optional name) or a sender ID. The `name` field is ignored when `id` is provided.\n","properties":{"email":{"description":"Sender email address. Required when `id` is not provided.","example":"no-reply@myshop.com","format":"email","type":"string"},"id":{"description":"Sender identifier. Required when `email` is not provided. Use this field to select a sender with a specific IP pool (dedicated IP users only).","example":2,"format":"int64","type":"integer"},"name":{"description":"Display name of the sender. Maximum length is 70 characters. Only applicable when `email` is provided.\n","example":"Mary from MyShop","type":"string"}},"type":"object"},"subject":{"description":"Email subject line. Required when `templateId` is not provided.\n","example":"Login Email confirmation","type":"string"},"tags":{"description":"Array of tags for categorizing and filtering emails","items":{"example":"tag1","type":"string"},"type":"array"},"templateId":{"description":"Template identifier","example":2,"format":"int64","type":"integer"},"textContent":{"description":"Plain text body content of the email. Ignored when `templateId` is provided.\n","example":"Please confirm your email address by clicking on the link https://text.domain.com","type":"string"},"to":{"description":"Array of recipient objects. Each object contains an email address and an optional display name. Required when `messageVersions` is not provided. Ignored when `messageVersions` is provided. Example: `[{\"name\":\"Jimmy\", \"email\":\"jimmy@example.com\"}, {\"name\":\"Joe\", \"email\":\"joe@example.com\"}]`\n","items":{"properties":{"contactPixelTrackingConsent":{"description":"Consent of the recipient for open (pixel) and click tracking, resolved by the sender at send time. Considered only if the per-contact pixel tracking consent feature is enabled for your account. Pass `true` if this recipient has consented to open and click tracking, in which case the open pixel and tracked links identify the recipient. Pass `false` to anonymise the open and click events (counted in aggregate statistics only). If it is not passed, the recipient is treated as unknown consent status and the email is still sent (the open and click are anonymised unless your account tracks unknown-consent contacts). A value other than `true`/`false` is rejected. Ignored when the feature is not enabled for your account.\n","example":true,"type":"boolean"},"email":{"description":"Email address of the recipient","example":"jimmy98@example.com","format":"email","type":"string"},"name":{"description":"Display name of the recipient. Maximum length is 70 characters.\n","example":"Jimmy","type":"string"}},"required":["email"],"type":"object"},"type":"array"}},"type":"object"},"examples":{"static-content":{"summary":"Static content example","description":"Example request with static HTML content","value":{"sender":{"name":"Alex from Brevo","email":"hello@brevo.com"},"to":[{"email":"johndoe@example.com","name":"John Doe"}],"subject":"Hello from Brevo!","htmlContent":"Hello,
This is my first transactional email sent from Brevo."}},"dynamic-content":{"summary":"Dynamic content example","description":"Example request with dynamic content using template variables","value":{"sender":{"name":"Alex from Brevo","email":"hello@brevo.com"},"to":[{"email":"johndoe@example.com","name":"John Doe"}],"subject":"Hello from Brevo!","params":{"trackingCode":"JD01460000300002350000","estimatedArrival":"Tomorrow"},"htmlContent":"Your delivery is expected {{params.estimatedArrival}}.Your tracking code: {{params.trackingCode}}"}}}}},"description":"Request body parameters for sending a transactional email","required":true},"responses":{"201":{"content":{"application/json":{"examples":{"response":{"value":{"messageId":"<201798300811.5787683@relay.domain.com>"}}},"schema":{"properties":{"messageId":{"description":"Message ID of the transactional email sent","example":"<201798300811.5787683@relay.domain.com>","type":"string"},"messageIds":{"items":{"description":"Message ID for each version of the transactional email sent","example":["<201798300811.5787683@relay.domain.com>","<201798300811.5787683@relay.domain.com>"],"type":"string"},"type":"array"}},"type":"object"}}},"description":"Transactional email sent successfully"},"202":{"content":{"application/json":{"examples":{"response":{"value":{"messageId":"<201798300811.5787683@relay.domain.com>"}}},"schema":{"properties":{"batchId":{"description":"Batch identifier for the scheduled transactional email","example":"5c6cfa04-eed9-42c2-8b5c-6d470d978e9d","type":"string"},"messageId":{"description":"Message ID of the transactional email scheduled","example":"<201798300811.5787683@relay.domain.com>","type":"string"},"messageIds":{"items":{"description":"Message ID for each version of the transactional email scheduled","type":"string"},"type":"array"}},"type":"object"}}},"description":"Transactional email scheduled successfully"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Send a transactional email","description":"Send a transactional email to one or more recipients, either using inline HTML content or a pre-built template via `templateId`. You can schedule emails for future delivery using `scheduledAt` (UTC, up to 5-minute delay), send multiple personalized versions with `messageVersions` (max 2000 total recipients, 99 per version), and attach files via URL or base64-encoded content. A `sender` and `subject` are required when no `templateId` is provided; when a `templateId` is used, the template''s sender and subject are applied unless overridden.","tags":["Transactional emails"],"parameters":[]}},"/smtp/email/{identifier}":{"delete":{"description":"Delete scheduled batch of emails by batchId or single scheduled email by messageId","operationId":"deleteScheduledEmailById","parameters":[{"description":"The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`).","examples":{"batchId":{"summary":"batchId of scheduled batch","value":"4320f270-a4e3-4a2e-b591-edfe30a5e627"},"messageId":{"summary":"messageId of scheduled email","value":"<202202231031.53307417725@smtp-relay.mailin.fr>"}},"in":"path","name":"identifier","required":true,"schema":{"type":"string"}}],"responses":{"204":{"content":{},"description":"Scheduled email(s) deleted"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Delete scheduled emails by batchId or messageId","tags":["Transactional emails"]}},"/smtp/emailStatus/{identifier}":{"get":{"description":"Fetch scheduled batch of emails by batchId or single scheduled email by messageId (Can retrieve data upto 30 days old)","operationId":"getScheduledEmailById","parameters":[{"description":"The `batchId` of scheduled emails batch (must be a valid UUIDv4) or the `messageId` of scheduled email (enclosed in angle brackets with @ sign, e.g. `<...@domain>`). When using `messageId`, the `limit`, `offset`, `sort`, and `status` query parameters are ignored.","examples":{"batchId":{"summary":"batchId of scheduled batch","value":"4320f270-a4e3-4a2e-b591-edfe30a5e627"},"messageId":{"summary":"messageId of scheduled email","value":"<202202231031.53307417725@smtp-relay.mailin.fr>"}},"in":"path","name":"identifier","required":true,"schema":{"type":"string"}},{"description":"Mandatory if `endDate` is used. Starting date (YYYY-MM-DD) from which you want to fetch the list. Cannot be more than 30 days older than the current date.","example":"2022-02-02","in":"query","name":"startDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Mandatory if `startDate` is used. Ending date (YYYY-MM-DD) till which you want to fetch the list. Maximum time period that can be selected is one month.","example":"2022-03-02","in":"query","name":"endDate","required":false,"schema":{"format":"date","type":"string"}},{"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed. Not valid when identifier is `messageId`.","in":"query","name":"sort","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Filter the records by `status` of the scheduled email batch or message. Not valid when identifier is `messageId`.","in":"query","name":"status","required":false,"schema":{"enum":["processed","inProgress","queued"],"type":"string"}},{"description":"Number of documents returned per page. Not valid when identifier is `messageId`.","example":100,"in":"query","name":"limit","required":false,"schema":{"default":100,"format":"int64","maximum":500,"minimum":0,"type":"integer"}},{"description":"Index of the first document on the page. Not valid when identifier is `messageId`.","example":0,"in":"query","name":"offset","required":false,"schema":{"default":0,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"batchId":{"value":{"batches":[{"createdAt":"2022-02-26T11:36:43.576000000Z","scheduledAt":"2022-02-28T11:36:43.576000000Z","status":"queued"},{"createdAt":"2022-02-24T11:36:43.576000000Z","scheduledAt":"2022-02-25T11:36:43.576000000Z","status":"processed"},{"createdAt":"2022-02-25T11:36:43.576000000Z","scheduledAt":"2022-02-26T11:36:43.576000000Z","status":"inProgress"}],"count":3}},"messageId":{"value":{"createdAt":"2022-02-26T11:36:43.576000000Z","scheduledAt":"2022-02-28T11:36:43.576000000Z","status":"queued"}}},"schema":{"oneOf":[{"properties":{"batches":{"items":{"properties":{"createdAt":{"description":"Datetime on which the batch was scheduled","format":"date-time","type":"string"},"scheduledAt":{"description":"Datetime for which the batch was scheduled","format":"date-time","type":"string"},"status":{"description":"Current status of the scheduled batch","enum":["inProgress","queued","processed","error"],"type":"string"}},"required":["scheduledAt","createdAt","status"],"type":"object"},"type":"array"},"count":{"description":"Total number of batches","type":"integer"}},"type":"object"},{"properties":{"createdAt":{"description":"Datetime on which the email was scheduled","format":"date-time","type":"string"},"scheduledAt":{"description":"Datetime for which the email was scheduled","format":"date-time","type":"string"},"status":{"description":"Current status of the scheduled email","enum":["inProgress","queued","processed","error"],"type":"string"}},"required":["scheduledAt","createdAt","status"],"type":"object"}]}}},"description":"Scheduled email batches"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Fetch scheduled emails by batchId or messageId","tags":["Transactional emails"]}},"/smtp/emails":{"get":{"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":[{"description":"**Mandatory if templateId and messageId are not passed in query filters.** Email address to which transactional email has been sent.\n","in":"query","name":"email","schema":{"type":"string"}},{"description":"**Mandatory if email and messageId are not passed in query filters.** Id of the template that was used to compose transactional email.\n","in":"query","name":"templateId","schema":{"format":"int64","type":"integer"}},{"description":"**Mandatory if templateId and email are not passed in query filters.** Message ID of the transactional email sent.\n","in":"query","name":"messageId","schema":{"type":"string"}},{"description":"**Mandatory if endDate is used.** Starting date (YYYY-MM-DD) from which you want to fetch the list. **Maximum time period that can be selected is one month**.\n","in":"query","name":"startDate","schema":{"type":"string"}},{"description":"**Mandatory if startDate is used.** Ending date (YYYY-MM-DD) till which you want to fetch the list. **Maximum time period that can be selected is one month.**\n","in":"query","name":"endDate","schema":{"type":"string"}},{"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","in":"query","name":"sort","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Number of documents returned per page","in":"query","name":"limit","schema":{"default":500,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Index of the first document in the page","in":"query","name":"offset","schema":{"default":0,"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"count":120,"transactionalEmails":[{"date":"2019-05-25T11:53:26Z","email":"abc@xyz.com","messageId":"<201798300811.5787683@relay.domain.com>","subject":"summer camp","templateId":15,"uuid":"5a78c-209ok98262910-std2341"},{"date":"2019-05-25T07:28:11Z","email":"test@test.com","messageId":"<201798300811.5700093@relay.domain.com>","subject":"details verification","templateId":15,"uuid":"5a78c-209ok98262910-s99a341"}]}}},"schema":{"properties":{"count":{"description":"Total number of transactional emails available on your account according to the passed filter","example":5,"format":"int64","type":"integer"},"transactionalEmails":{"items":{"properties":{"date":{"description":"Date on which transactional email was sent","example":"2017-03-12T12:30:00Z","type":"string"},"email":{"description":"Email address to which transactional email has been sent","example":"john.smith@example.com","format":"email","type":"string"},"from":{"description":"Email address of the sender from which the email was sent","example":"diana.doe@example.com","format":"email","type":"string"},"messageId":{"description":"Message Id of the sent email","example":"<201798300811.5700093@relay.domain.com>","type":"string"},"subject":{"description":"Subject of the sent email","example":"Summer Camp","type":"string"},"tags":{"description":"Tags used for your email","items":{"example":"tag1","type":"string"},"type":"array"},"templateId":{"description":"Id of the template","example":2,"format":"int64","type":"integer"},"uuid":{"description":"Unique id of the email sent to a particular contact","example":"5a78c-209ok98262910-s99a341","type":"string"}},"required":["date","email","messageId","subject","uuid"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"List of transactional emails"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get the list of transactional emails on the basis of allowed filters","tags":["Transactional emails"]}},"/smtp/emails/{uuid}":{"get":{"description":"This is the actual html content sent
","date":"2016-02-25T11:53:26Z","email":"abc@example.com","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"}],"subject":"Summer Camps","templateId":12}}},"schema":{"properties":{"attachmentCount":{"description":"Count of the attachments that were sent in the email","example":2,"format":"int64","type":"integer"},"body":{"description":"Actual content of the transactional email that has been sent","example":"This is the actual html content sent
","type":"string"},"date":{"description":"Date on which transactional email was sent","example":"2017-03-12T12:30:00Z","type":"string"},"email":{"description":"Email address to which transactional email has been sent","example":"abc@example.com","format":"email","type":"string"},"events":{"description":"Series of events which occurred on the transactional email","items":{"properties":{"name":{"description":"Name of the event that occurred on the sent email","example":"delivered","type":"string"},"time":{"description":"Time at which the event occurred","example":"2017-03-12T12:30:00Z","type":"string"}},"required":["name","time"],"type":"object"},"type":"array"},"subject":{"description":"Subject of the sent email","example":"Summer Camp","type":"string"},"templateId":{"description":"Id of the template","example":2,"format":"int64","type":"integer"}},"required":["date","email","events","subject"],"type":"object"}}},"description":"Transactional email content"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get the personalized content of a sent transactional email","tags":["Transactional emails"]}},"/smtp/log/{identifier}":{"delete":{"parameters":[{"description":"MessageId or email address of the transactional log(s) to delete. Must be a valid message ID (enclosed in angle brackets with @ sign) or a valid email address.","in":"path","name":"identifier","required":true,"schema":{"type":"string"}},{"description":"Starting date (YYYY-MM-DD) to narrow down logs for deletion","in":"query","name":"from_date","required":false,"schema":{"type":"string"}},{"description":"Ending date (YYYY-MM-DD) to narrow down logs for deletion","in":"query","name":"to_date","required":false,"schema":{"type":"string"}}],"responses":{"204":{"content":{},"description":"Transactional Logs deleted"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}},"description":"Message ID not found"}},"summary":"Delete an SMTP transactional log","description":"Delete SMTP transactional log entries identified by a message ID (enclosed in angle brackets with an @ sign) or a valid email address. Optionally narrow the deletion to a specific date range using `from_date` and `to_date` query parameters (YYYY-MM-DD format). The operation also removes any associated stored email preview content.","tags":["Transactional emails"]}},"/smtp/statistics/aggregatedReport":{"get":{"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":[{"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate\n","in":"query","name":"startDate","schema":{"type":"string"}},{"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate\n","in":"query","name":"endDate","schema":{"type":"string"}},{"description":"Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 90 if neither dates nor days are provided.\n","in":"query","name":"days","schema":{"format":"int64","maximum":90,"type":"integer"}},{"description":"Tag of the emails","in":"query","name":"tag","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"blocked":2,"clicks":9987,"delivered":18996,"hardBounces":234,"invalid":0,"opens":17654,"range":"2016-09-08|2017-04-28","requests":19887,"softBounces":1533,"spamReports":1,"uniqueClicks":8766,"uniqueOpens":13688,"unsubscribed":2}}},"schema":{"properties":{"blocked":{"description":"Number of blocked contact emails for the timeframe","example":2,"format":"int64","type":"integer"},"clicks":{"description":"Number of clicks for the timeframe","example":12,"format":"int64","type":"integer"},"delivered":{"description":"Number of delivered emails for the timeframe","example":249,"format":"int64","type":"integer"},"hardBounces":{"description":"Number of hardbounces for the timeframe","example":1,"format":"int64","type":"integer"},"invalid":{"description":"Number of invalid emails for the timeframe","example":0,"format":"int64","type":"integer"},"opens":{"description":"Number of openings for the timeframe","example":47,"format":"int64","type":"integer"},"range":{"description":"Time frame of the report","example":"2016-09-08|2017-04-06","type":"string"},"requests":{"description":"Number of requests for the timeframe","example":263,"format":"int64","type":"integer"},"softBounces":{"description":"Number of softbounces for the timeframe","example":4,"format":"int64","type":"integer"},"spamReports":{"description":"Number of complaint (spam report) for the timeframe","example":0,"format":"int64","type":"integer"},"uniqueClicks":{"description":"Number of unique clicks for the timeframe","example":8,"format":"int64","type":"integer"},"uniqueOpens":{"description":"Number of unique openings for the timeframe","example":37,"format":"int64","type":"integer"},"unsubscribed":{"description":"Number of unsubscribed emails for the timeframe","example":0,"format":"int64","type":"integer"}},"type":"object"}}},"description":"Aggregated report informations"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get your transactional email activity aggregated over a period of time","tags":["Transactional emails"]}},"/smtp/statistics/events":{"get":{"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":[{"description":"Number limitation for the result returned","in":"query","name":"limit","schema":{"default":2500,"format":"int64","maximum":5000,"minimum":0,"type":"integer"}},{"description":"Beginning point in the list to retrieve from.","in":"query","name":"offset","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD). Must be lower than equal to endDate\n","in":"query","name":"startDate","schema":{"type":"string"}},{"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD). Must be greater than equal to startDate\n","in":"query","name":"endDate","schema":{"type":"string"}},{"description":"Number of days in the past including today (positive integer, maximum 90). _Not compatible with 'startDate' and 'endDate'_. Defaults to 30 if neither dates nor days are provided.\n","in":"query","name":"days","schema":{"format":"int64","maximum":90,"type":"integer"}},{"description":"Filter the report for a specific email addresses","in":"query","name":"email","schema":{"format":"email","type":"string"}},{"description":"Filter the report for a specific event type","in":"query","name":"event","schema":{"enum":["bounces","hardBounces","softBounces","delivered","spam","requests","opened","clicks","invalid","deferred","blocked","unsubscribed","error","loadedByProxy"],"type":"string"}},{"description":"Filter the report for tags (serialized and urlencoded array)","in":"query","name":"tags","schema":{"type":"string"}},{"description":"Filter on a specific message id","in":"query","name":"messageId","schema":{"type":"string"}},{"description":"Filter on a specific template id","in":"query","name":"templateId","schema":{"format":"int64","type":"integer"}},{"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","in":"query","name":"sort","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"events":[{"date":"2017-03-12T12:30:00Z","email":"john.smith@example.com","event":"deferred","from":"john@example.com","messageId":"<201798300811.5787683@example.domain.com>","reason":"Error connection timeout","tag":"OrderConfirmation","templateId":4},{"date":"2017-03-13T16:30:00Z","email":"john.smith@example.com","event":"delivered","from":"john@example.com","messageId":"<201798300811.5787683@example.domain.com>","tag":"OrderConfirmation","templateId":5}]}}},"schema":{"properties":{"events":{"items":{"properties":{"date":{"description":"UTC date-time on which the event has been generated","example":"2017-03-12T12:30:00Z","type":"string"},"email":{"description":"Email address which generates the event","example":"john.smith@example.com","format":"email","type":"string"},"event":{"description":"Event which occurred","enum":["bounces","hardBounces","softBounces","delivered","spam","requests","opened","clicks","invalid","deferred","blocked","unsubscribed","error","loadedByProxy"],"example":"delivered","type":"string"},"from":{"description":"Sender email from which the emails are sent","example":"john@example.com","format":"email","type":"string"},"ip":{"description":"IP from which the user has opened the email or clicked on the link (only available if the event is opened or clicks)","example":"165.87.3.15","type":"string"},"link":{"description":"The link which is sent to the user (only available if the event is requests or opened or clicks)","example":"https://www.someexamplelink.com","type":"string"},"messageId":{"description":"Message ID which generated the event","example":"<201798300811.5787683@relay.domain.com>","type":"string"},"reason":{"description":"Reason of bounce (only available if the event is hardbounce or softbounce)","example":"Error connection timeout","type":"string"},"subject":{"description":"Subject of the event","example":"Sib client test","type":"string"},"tag":{"description":"Tag of the email which generated the event","example":"OrderConfirmation","type":"string"},"templateId":{"description":"ID of the template (only available if the email is template based)","example":4,"format":"int64","type":"integer"}},"required":["date","email","event","messageId"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"Email events report informations"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get all your transactional email activity (unaggregated events)","tags":["Transactional emails"]}},"/smtp/statistics/reports":{"get":{"description":"This endpoint will show the aggregated stats per day for the past 10 days by default if `startDate` and `endDate` OR `days` is not passed. The date range can not exceed 30 days.","operationId":"getSmtpReport","parameters":[{"description":"Number of documents returned per page","in":"query","name":"limit","schema":{"default":10,"format":"int64","maximum":30,"minimum":0,"type":"integer"}},{"description":"Index of the first document on the page","in":"query","name":"offset","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"**Mandatory if endDate is used.** Starting date of the report (YYYY-MM-DD)\n","in":"query","name":"startDate","schema":{"type":"string"}},{"description":"**Mandatory if startDate is used.** Ending date of the report (YYYY-MM-DD)\n","in":"query","name":"endDate","schema":{"type":"string"}},{"description":"Number of days in the past including today (positive integer, maximum 30). _Not compatible with 'startDate' and 'endDate'_\n","in":"query","name":"days","schema":{"format":"int64","maximum":30,"type":"integer"}},{"description":"Tag of the emails","in":"query","name":"tag","schema":{"type":"string"}},{"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","in":"query","name":"sort","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"reports":[{"blocked":519,"clicks":1026,"date":"2017-04-30","delivered":10103,"hardBounces":21,"invalid":1,"opens":5091,"requests":10756,"softBounces":137,"spamReports":0,"uniqueClicks":720,"uniqueOpens":2318,"unsubscribed":0},{"blocked":920,"clicks":1514,"date":"2017-05-01","delivered":17499,"hardBounces":34,"invalid":2,"opens":10089,"requests":18812,"softBounces":254,"spamReports":0,"uniqueClicks":1090,"uniqueOpens":4393,"unsubscribed":3}]}}},"schema":{"properties":{"reports":{"items":{"properties":{"blocked":{"description":"Number of blocked emails for the date","example":0,"format":"int64","type":"integer"},"clicks":{"description":"Number of clicks for the date","example":6,"format":"int64","type":"integer"},"date":{"description":"Date of the statistics","example":"2017-04-06","format":"date","type":"string"},"delivered":{"description":"Number of delivered emails for the date","example":63,"format":"int64","type":"integer"},"hardBounces":{"description":"Number of hardbounces for the date","example":1,"format":"int64","type":"integer"},"invalid":{"description":"Number of invalid emails for the date","example":0,"format":"int64","type":"integer"},"opens":{"description":"Number of openings for the date","example":58,"format":"int64","type":"integer"},"requests":{"description":"Number of requests for the date","example":65,"format":"int64","type":"integer"},"softBounces":{"description":"Number of softbounces for the date","example":1,"format":"int64","type":"integer"},"spamReports":{"description":"Number of complaints (spam reports) for the date","example":0,"format":"int64","type":"integer"},"uniqueClicks":{"description":"Number of unique clicks for the date","example":5,"format":"int64","type":"integer"},"uniqueOpens":{"description":"Number of unique openings for the date","example":52,"format":"int64","type":"integer"},"unsubscribed":{"description":"Number of unsubscribed emails for the date","example":0,"format":"int64","type":"integer"}},"required":["blocked","clicks","date","delivered","hardBounces","invalid","opens","requests","softBounces","spamReports","uniqueClicks","uniqueOpens","unsubscribed"],"type":"object"},"type":"array"}},"type":"object"}}},"description":"Aggregated report informations"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get your transactional email activity aggregated per day","tags":["Transactional emails"]}},"/smtp/template/preview":{"post":{"operationId":"postPreviewSmtpEmailTemplates","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"required":["email"]},{"required":["params"]}],"properties":{"email":{"description":"Email of the contact.(Required if params not provided)","example":"john.doe@example.com","type":"string"},"params":{"description":"Key-value pairs of dynamic parameters for template rendering.(Required if email not provided) For example: **{\"Firstname\":\"John\", \"Lastname\":\"Doe\"}**\n","properties":{"Firstname":{"description":"firstname of the contact. **Dynamic parameter**\n","example":"John","type":"string"},"Lastname":{"description":"Lastname of the contact. **Dynamic parameter**","example":"Doe","type":"string"}},"type":"object"},"templateId":{"description":"Id of the template.","example":22,"type":"integer"}},"required":["templateId"],"type":"object"}}},"description":"Values to fetch Template preview","required":true},"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"fromEmail":"nikon.doe@example.com","fromName":"Nikon Doe","html":"html content
","previewText":"Preview text","subject":"Template preview subject","usedFeedNames":"[\"feed_1\",\"feed_2\"]"}}},"schema":{"properties":{"fromEmail":{"description":"Sender email address","example":"nikon.doe@example.com","type":"string"},"fromName":{"description":"Sender Name","example":"Nikon doe","type":"string"},"html":{"description":"Html content of the template","example":"html content,feed_1_value, feed_2_value
","type":"string"},"previewText":{"description":"Preview text of the template","example":"Preview text","type":"string"},"subject":{"description":"subject of the template","example":"Template preview subject","type":"string"},"usedFeedNames":{"example":["feed_1","feed_2"],"items":{"description":"feeds alias used in the template","type":"string"},"type":"array"}},"type":"object"}}},"description":"successfully fetched template's preview fields"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Generate the rendered preview of transactional template","description":"Generate a fully rendered preview of a transactional email template by resolving dynamic variables. Provide either an `email` address (to populate variables from the contact''s attributes) or a `params` object with key-value pairs for manual substitution; at least one of these is required alongside the mandatory `templateId`. The response includes the rendered HTML, subject, sender details, preview text, and any feed names used in the template.","tags":["Transactional emails"],"parameters":[]}},"/smtp/templates":{"get":{"operationId":"getSmtpTemplates","parameters":[{"description":"Filter on the status of the template. Active = true, inactive = false","in":"query","name":"templateStatus","schema":{"type":"boolean"}},{"description":"Number of documents returned per page","in":"query","name":"limit","schema":{"default":50,"format":"int64","maximum":1000,"minimum":0,"type":"integer"}},{"description":"Index of the first document in the page","in":"query","name":"offset","schema":{"default":0,"format":"int64","type":"integer"}},{"description":"Sort the results in the ascending/descending order of record creation. Default order is **descending** if `sort` is not passed","in":"query","name":"sort","required":false,"schema":{"default":"desc","enum":["asc","desc"],"type":"string"}},{"description":"Filter on the editor type used to create the template. Currently only `richTextEditor` is supported as a filter value.","in":"query","name":"editorType","required":false,"schema":{"enum":["richTextEditor"],"type":"string"}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"count":2,"templates":[{"createdAt":"2016-02-24T14:44:24Z","htmlContent":"HTML CONTENT 1","id":5,"isActive":false,"modifiedAt":"2016-02-24T15:37:11Z","name":"ChristomasTimeTemplate","replyTo":"replyto@domain.com","sender":{"email":"john.smith@example.com","id":23,"name":"John"},"subject":"Merry Christmas","tag":"Festival","testSent":false,"toField":""},{"createdAt":"2016-02-25T11:53:26Z","htmlContent":"HTML CONTENT 2","id":12,"isActive":true,"modifiedAt":"2016-02-25T11:53:26Z","name":"SummerSales2017Template","replyTo":"replyto@domain.com","sender":{"email":"john.smith@example.com","id":23,"name":"John"},"subject":"Enjoy our summer Sales !","tag":"Summer","testSent":false,"toField":""}]}}},"schema":{"properties":{"count":{"description":"Count of transactional email templates","example":1,"format":"int64","type":"integer"},"templates":{"items":{"$ref":"#/components/schemas/getSmtpTemplateOverview"},"type":"array"}},"type":"object"}}},"description":"transactional email templates informations"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Get the list of email templates","description":"Retrieve a paginated list of all transactional email templates (including automation templates) with their details such as name, subject, sender, status, HTML content, and timestamps. Results default to 50 per page (max 1000) and are sorted in descending creation order unless overridden. You can filter by active/inactive status using `templateStatus` and by editor type using `editorType` (currently only `richTextEditor` is supported).","tags":["Transactional emails"]},"post":{"operationId":"createSmtpTemplate","requestBody":{"content":{"application/json":{"schema":{"properties":{"attachmentUrl":{"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'\n","example":"https://attachment.domain.com","format":"url","type":"string"},"htmlContent":{"description":"Body of the message (HTML version). The field must have more than 10 characters. **REQUIRED if htmlUrl is empty**\n","example":"The order n°xxxxx has been confirmed. Thanks for your purchase","type":"string"},"htmlUrl":{"description":"Url which contents the body of the email message. REQUIRED if htmlContent is empty","example":"https://html.domain.com","format":"url","type":"string"},"isActive":{"description":"Status of template. isActive = true means template is active and isActive = false means template is inactive","example":true,"type":"boolean"},"replyTo":{"description":"Email on which campaign recipients will be able to reply to","example":"support@myshop.com","format":"email","type":"string"},"sender":{"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}**\n","properties":{"email":{"description":"Email of the sender","example":"contact@myshop.com","format":"email","type":"string"},"id":{"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)_.\n","example":3,"format":"int64","type":"integer"},"name":{"description":"Name of the sender. **If not passed, will be set to default**\n","example":"Mary from MyShop","type":"string"}},"type":"object"},"subject":{"description":"Subject of the template","example":"Thanks for your purchase !","type":"string"},"tag":{"description":"Tag of the template","example":"OrderConfirmation","type":"string"},"templateName":{"description":"Name of the template","example":"Order Confirmation - EN","type":"string"},"toField":{"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\n","example":"{FNAME} {LNAME}","type":"string"}},"required":["sender","subject","templateName"],"type":"object"}}},"description":"values to update in transactional email template","required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"id":{"description":"ID of the object created","example":5,"format":"int64","type":"integer"}},"required":["id"],"type":"object"}}},"description":"successfully created"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"}},"summary":"Create an email template","description":"Create a new transactional email template with the specified sender, subject, and content. The `sender`, `subject`, and `templateName` fields are required. Template content can be provided via `htmlContent` (minimum 10 characters) or `htmlUrl`; at least one must be supplied. Templates are created as inactive by default unless `isActive` is explicitly set to `true`.","tags":["Transactional emails"],"parameters":[]}},"/smtp/templates/{templateId}":{"delete":{"operationId":"deleteSmtpTemplate","parameters":[{"description":"id of the template","in":"path","name":"templateId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"content":{},"description":"Inactive transactional email template has been deleted"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}},"description":"Template ID not found"}},"summary":"Delete an inactive email template","description":"Permanently delete a transactional email template by its numeric ID. Only inactive templates can be deleted; attempting to delete an active template returns a 405 error. To deactivate a template before deletion, use `PUT /smtp/templates/{templateId}` with `isActive` set to `false`. Deletion also removes associated newsletter template data and triggers asynchronous cleanup of shared assets.","tags":["Transactional emails"]},"get":{"operationId":"getSmtpTemplate","parameters":[{"description":"ID of the template. Can be a numeric template ID or a custom template identifier string (alphanumeric, hyphens, and underscores only, max 64 characters, must start with a letter).","in":"path","name":"templateId","required":true,"schema":{"oneOf":[{"format":"int64","type":"integer"},{"type":"string"}]}}],"responses":{"200":{"content":{"application/json":{"examples":{"response":{"value":{"createdAt":"2016-02-25T11:53:26Z","doiTemplate":false,"htmlContent":"HTML CONTENT 4","id":33,"isActive":true,"modifiedAt":"2016-02-25T11:53:26Z","name":"OrderConfirmation","replyTo":"replyto@domain.com","sender":{"email":"john.smith@example.com","id":26,"name":"John"},"subject":"Order Confirmation : Thanks for your Purchase !","tag":"","testSent":false,"toField":""}}},"schema":{"$ref":"#/components/schemas/getSmtpTemplateOverview"}}},"description":"Email template informations"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}},"description":"Template ID not found"}},"summary":"Returns the template information","description":"Retrieve the full details of a specific transactional email template by its numeric ID or custom template identifier string. The response includes the template name, subject, sender information, HTML content, active status, creation and modification timestamps, reply-to address, tag, and a `doiTemplate` flag indicating whether the template is a double opt-in template (detected by the presence of optin-related tags or variables in the content).","tags":["Transactional emails"]},"put":{"operationId":"updateSmtpTemplate","parameters":[{"description":"ID of the template. Can be a numeric template ID or a custom template identifier string.","in":"path","name":"templateId","required":true,"schema":{"oneOf":[{"format":"int64","type":"integer"},{"type":"string"}]}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"attachmentUrl":{"description":"Absolute url of the attachment (**no local file**). Extensions 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\n","example":"https://attachment.domain.com","format":"url","type":"string"},"htmlContent":{"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)\n","example":"The order n°xxxxx has been confirmed. Thanks for your purchase","type":"string"},"htmlUrl":{"description":"**Required if htmlContent is empty**. URL to the body of the email (HTML)\n","example":"https://html.domain.com","format":"url","type":"string"},"isActive":{"description":"Status of the template. isActive = false means template is inactive, isActive = true means template is active","example":true,"type":"boolean"},"replyTo":{"description":"Email on which campaign recipients will be able to reply to","example":"support@myshop.com","format":"email","type":"string"},"sender":{"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}**\n","properties":{"email":{"description":"Email of the sender","example":"contact@myshop.com","format":"email","type":"string"},"id":{"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)_.\n","example":3,"format":"int64","type":"integer"},"name":{"description":"Name of the sender","example":"Mary from MyShop","type":"string"}},"type":"object"},"subject":{"description":"Subject of the email","example":"Thanks for your purchase !","type":"string"},"tag":{"description":"Tag of the template","example":"OrderConfirmation","type":"string"},"templateName":{"description":"Name of the template","example":"Order Confirmation - EN","type":"string"},"toField":{"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\n","example":"{FNAME} {LNAME}","type":"string"}},"type":"object"}}},"description":"values to update in transactional email template","required":true},"responses":{"204":{"content":{},"description":"transactional email template updated"},"400":{"content":{"application/json":{"schema":{"properties":{"code":{"description":"Error code displayed in case of a failure","enum":["invalid_parameter","missing_parameter","out_of_range","campaign_processing","campaign_sent","document_not_found","not_enough_credits","permission_denied","duplicate_parameter","duplicate_request","method_not_allowed","unauthorized","account_under_validation","not_acceptable","bad_request","unprocessable_entity","Domain does not exist","Contact email not found","Attribute not found","Category id not found","Invalid parameters passed","Record(s) for identifier not found","Returned when query params are invalid","Returned when invalid data posted","Feed not found","Campaign ID not found","api-key not found","DMARC policy requires domain authentication","DNS records not properly configured","Invalid OTP code provided","OTP code has expired","Domain already exists in your account","The sum of all IP weights must equal 100","Authentication failed","Insufficient credits","Request already processed"],"example":"method_not_allowed","type":"string"},"message":{"description":"Readable message associated to the failure","example":"POST Method is not allowed on this path","type":"string"}},"required":["code","message"],"type":"object"}}},"description":"bad request"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}},"description":"Template ID not found"}},"summary":"Update an email template","description":"Update an existing transactional email template by its numeric ID or custom template identifier string. All fields in the request body are optional; only the provided fields will be updated. You can update the template name, subject, sender, reply-to address, HTML content (via `htmlContent` or `htmlUrl`), active status, tag, attachment URL, and the personalized `toField`. Only one of sender email or sender ID should be provided per request.","tags":["Transactional emails"]}},"/smtp/templates/{templateId}/sendTest":{"post":{"operationId":"sendTestTemplate","parameters":[{"description":"Id of the template","in":"path","name":"templateId","required":true,"schema":{"format":"int64","type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/sendTestEmail"}}},"required":true},"responses":{"204":{"content":{},"description":"Test email has been sent successfully to all recipients"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/postSendFailed"}}},"description":"Test email could not be sent to the following email addresses"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/errorModel"}}},"description":"Template ID not found"}},"summary":"Send a template to your test list","description":"Send a test email of the specified transactional template to one or more recipients. Provide an array of email addresses in the `emailTo` field; if left empty, the test mail is sent to your entire test list. You can send a maximum of 50 test emails per day, and all provided email addresses must be valid.","tags":["Transactional emails"]}}}}