{"openapi":"3.0.0","info":{"description":"Elastic Email v4 API for email campaigns, transactional sends, templates, contacts and lists","version":"v4"},"servers":[{"description":"Elastic Email v4 API for email campaigns, transactional sends, templates, contacts and lists","url":"https://api.apirails.com/elasticemail"}],"paths":{"/campaigns":{"get":{"tags":["Transactional Email"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Text fragment used for searching in Campaign name (using the 'contains' rule)","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsGet","api_endpoint":"https://api.elasticemail.com/v4/campaigns"},"summary":"Load Campaigns","description":"Load Campaigns | Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Campaigns"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsPost","api_endpoint":"https://api.elasticemail.com/v4/campaigns"},"summary":"Add Campaign","description":"Add Campaign | Add a campaign for processing. Required Access Level: ModifyCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Content":{"type":"array","description":"Campaign's email content. Provide multiple items to send an A/X Split Campaign","items":{"type":"object","properties":{"AttachFiles":{"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"From":{"type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )","required":true},"Poolname":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ReplyTo":{"type":"string","description":"To what addresses should the recipients reply to (e.g. John Doe )"},"Subject":{"type":"string","description":"Default subject of email."},"TemplateName":{"type":"string","description":"Name of template."},"Utm":{"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."}}}},"ExcludedRecipients":{"type":"object","description":"A set of lists and segments names to read recipients from","properties":{"ListNames":{"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"type":"array","description":"Names of segments from your Account to read recipients from"}}},"Name":{"type":"string","description":"Campaign name","required":true},"Options":{"type":"object","description":"Different send options for a Campaign","properties":{"DeliveryOptimization":{"type":"string","description":"body.Options.DeliveryOptimization (string field from the documented request schema)"},"ScheduleFor":{"type":"string","description":"Date when this Campaign is scheduled to be sent on"},"SendAtLocalTime":{"type":"boolean","description":"Send email at local time of contact.","enum":[true,false]},"SplitOptions":{"type":"object","description":"Optional A/X split campaign options"},"TrackClicks":{"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TrackOpens":{"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TriggerCount":{"type":"number","description":"How many times send the campaign"},"TriggerFrequency":{"type":"number","description":"How often (in minutes) to send the campaign"}}},"Recipients":{"type":"object","description":"A set of lists and segments names to read recipients from","required":true,"properties":{"ListNames":{"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"type":"array","description":"Names of segments from your Account to read recipients from"}}},"Status":{"type":"string","description":"body.Status (string field from the documented request schema)"}}},"example":{"Content":[[{"AttachFiles":["preuploaded.jpg"],"From":"John Doe ","Poolname":"My Custom Pool","ReplyTo":"John Doe ,John Doe2 ","Subject":"Hello!","TemplateName":"Template01","Utm":{"Campaign":"string","Content":"string","Medium":"string","Source":"string"}}]],"ExcludedRecipients":[{"ListNames":["string"],"SegmentNames":["string"]}],"Name":["string"],"Options":[{"DeliveryOptimization":"None","ScheduleFor":"string","SendAtLocalTime":false,"SplitOptions":{"OptimizeFor":"Opens","OptimizePeriodMinutes":"30"},"TrackClicks":"true","TrackOpens":"true","TriggerCount":0,"TriggerFrequency":0}],"Recipients":[{"ListNames":["string"],"SegmentNames":["string"]}],"Status":["Deleted"]}}}}}},"/campaigns/{name}":{"get":{"tags":["Campaigns"],"parameters":[{"name":"name","in":"path","description":"Name of Campaign to get","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/campaigns/{name}"},"summary":"Load Campaign","description":"Load Campaign | Returns the specified campaign details. Required Access Level: ViewCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Campaigns"],"parameters":[{"name":"name","in":"path","description":"Name of Campaign to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsByNamePut","api_endpoint":"https://api.elasticemail.com/v4/campaigns/{name}"},"summary":"Update Campaign","description":"Update Campaign | Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Content":{"type":"array","description":"Campaign's email content. Provide multiple items to send an A/X Split Campaign","items":{"type":"object","properties":{"AttachFiles":{"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"From":{"type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )","required":true},"Poolname":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ReplyTo":{"type":"string","description":"To what addresses should the recipients reply to (e.g. John Doe )"},"Subject":{"type":"string","description":"Default subject of email."},"TemplateName":{"type":"string","description":"Name of template."},"Utm":{"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."}}}},"ExcludedRecipients":{"type":"object","description":"A set of lists and segments names to read recipients from","properties":{"ListNames":{"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"type":"array","description":"Names of segments from your Account to read recipients from"}}},"Name":{"type":"string","description":"Campaign name","required":true},"Options":{"type":"object","description":"Different send options for a Campaign","properties":{"DeliveryOptimization":{"type":"string","description":"body.Options.DeliveryOptimization (string field from the documented request schema)"},"ScheduleFor":{"type":"string","description":"Date when this Campaign is scheduled to be sent on"},"SendAtLocalTime":{"type":"boolean","description":"Send email at local time of contact.","enum":[true,false]},"SplitOptions":{"type":"object","description":"Optional A/X split campaign options"},"TrackClicks":{"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TrackOpens":{"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TriggerCount":{"type":"number","description":"How many times send the campaign"},"TriggerFrequency":{"type":"number","description":"How often (in minutes) to send the campaign"}}},"Recipients":{"type":"object","description":"A set of lists and segments names to read recipients from","required":true,"properties":{"ListNames":{"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"type":"array","description":"Names of segments from your Account to read recipients from"}}},"Status":{"type":"string","description":"body.Status (string field from the documented request schema)"}}},"example":{"Content":[[{"AttachFiles":["preuploaded.jpg"],"From":"John Doe ","Poolname":"My Custom Pool","ReplyTo":"John Doe ,John Doe2 ","Subject":"Hello!","TemplateName":"Template01","Utm":{"Campaign":"string","Content":"string","Medium":"string","Source":"string"}}]],"ExcludedRecipients":[{"ListNames":["string"],"SegmentNames":["string"]}],"Name":["string"],"Options":[{"DeliveryOptimization":"None","ScheduleFor":"string","SendAtLocalTime":false,"SplitOptions":{"OptimizeFor":"Opens","OptimizePeriodMinutes":"30"},"TrackClicks":"true","TrackOpens":"true","TriggerCount":0,"TriggerFrequency":0}],"Recipients":[{"ListNames":["string"],"SegmentNames":["string"]}],"Status":["Deleted"]}}}}},"delete":{"tags":["Campaigns"],"parameters":[{"name":"name","in":"path","description":"Name of Campaign to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/campaigns/{name}"},"summary":"Delete Campaign","description":"Delete Campaign | Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/{name}/pause":{"put":{"tags":["Campaigns"],"parameters":[{"name":"name","in":"path","description":"Name of Campaign to pause","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsByNamePausePut","api_endpoint":"https://api.elasticemail.com/v4/campaigns/{name}/pause"},"summary":"Pause Campaign","description":"Pause Campaign | Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/campaigns/automation/{name}/trigger":{"post":{"tags":["Campaigns"],"parameters":[{"name":"name","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}},{"name":"contactEmail","in":"query","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#campaignsAutomationByNameTriggerPost","api_endpoint":"https://api.elasticemail.com/v4/campaigns/automation/{name}/trigger"},"summary":"Trigger Automation for Contact","description":"Trigger Automation for Contact | Manually trigger an Automation for a contact. Required Access Level: ModifyAutomations | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/contacts":{"get":{"tags":["Contacts"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsGet","api_endpoint":"https://api.elasticemail.com/v4/contacts"},"summary":"Load Contacts","description":"Load Contacts | Returns a list of contacts. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Contacts"],"parameters":[{"name":"listnames","in":"query","description":"Names of lists to which the uploaded contacts should be added to","required":false,"schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsPost","api_endpoint":"https://api.elasticemail.com/v4/contacts"},"summary":"Add Contact","description":"Add Contact | Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"array","description":"body (request body parameter from the official API reference)","items":{"type":"object","properties":{"Consent":{"type":"object","description":"body.Consent (object field from the documented request schema)"},"CustomFields":{"type":"object","description":"A key-value collection of custom contact fields which can be used in the system. Only already existing custom fields will be saved."},"Email":{"type":"string","description":"Proper email address.","required":true},"FirstName":{"type":"string","description":"First name."},"LastName":{"type":"string","description":"Last name."},"Status":{"type":"string","description":"body.Status (string field from the documented request schema)"}}}}}},"example":{"body":[[{"Consent":{"ConsentDate":"1/1/2015 0:00:00 AM","ConsentIP":"192.168.0.1","ConsentTracking":"Unknown"},"CustomFields":{"age":"34","city":"New York"},"Email":"mail@example.com","FirstName":"Fred","LastName":"Flintstone","Status":"Transactional"}]]}}}}}},"/contacts/{email}":{"get":{"tags":["Contacts"],"parameters":[{"name":"email","in":"path","description":"Proper email address.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsByEmailGet","api_endpoint":"https://api.elasticemail.com/v4/contacts/{email}"},"summary":"Load Contact","description":"Load Contact | Load detailed contact information for specified email. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Contacts"],"parameters":[{"name":"email","in":"path","description":"Proper email address.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsByEmailPut","api_endpoint":"https://api.elasticemail.com/v4/contacts/{email}"},"summary":"Update Contact","description":"Update Contact | Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CustomFields":{"type":"object","description":"A key-value collection of custom contact fields which can be used in the system.","properties":{}},"FirstName":{"type":"string","description":"First name."},"LastName":{"type":"string","description":"Last name."}}},"example":{"CustomFields":[{"age":"34","city":"New York"}],"FirstName":["Fred"],"LastName":["Flintstone"]}}}}},"delete":{"tags":["Contacts"],"parameters":[{"name":"email","in":"path","description":"Proper email address.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsByEmailDelete","api_endpoint":"https://api.elasticemail.com/v4/contacts/{email}"},"summary":"Delete Contact","description":"Delete Contact | Deletes the provided contact. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/contacts/delete":{"post":{"tags":["Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsDeletePost","api_endpoint":"https://api.elasticemail.com/v4/contacts/delete"},"summary":"Delete Contacts Bulk","description":"Delete Contacts Bulk | Deletes provided contacts in bulk. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Emails":{"type":"array","description":"Comma delimited list of contact emails","items":{"type":"string"}},"Rule":{"type":"string","description":"SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules"}}},"example":{"Emails":[["john.doe@sample.com"]],"Rule":["string"]}}}}}},"/contacts/export":{"post":{"tags":["Contacts"],"parameters":[{"name":"compressionFormat","in":"query","description":"FileResponse compression format. None or Zip.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["None","Zip"]}}},{"name":"emails","in":"query","description":"Comma delimited list of contact emails","required":false,"schema":{"type":"array","example":""}},{"name":"fileFormat","in":"query","description":"Format of the exported file","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["Csv","Xml","Json"]}}},{"name":"fileName","in":"query","description":"Name of your file including extension.","required":false,"schema":{"type":"string","example":""}},{"name":"rule","in":"query","description":"Query used for filtering.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsExportPost","api_endpoint":"https://api.elasticemail.com/v4/contacts/export"},"summary":"Export Contacts","description":"Export Contacts | Request an Export of specified Contacts. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/contacts/export/{id}/status":{"get":{"tags":["Contacts"],"parameters":[{"name":"id","in":"path","description":"ID of the exported file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsExportByIdStatusGet","api_endpoint":"https://api.elasticemail.com/v4/contacts/export/{id}/status"},"summary":"Check contact export status","description":"Check Export Status | Check the current status of the export. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/contacts/import":{"post":{"tags":["Contacts"],"parameters":[{"name":"encodingName","in":"query","description":"In what encoding the file is uploaded","required":false,"schema":{"type":"string","example":""}},{"name":"fileUrl","in":"query","description":"Optional url of csv to import","required":false,"schema":{"type":"string","example":""}},{"name":"listName","in":"query","description":"Name of an existing list to add these contacts to","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#contactsImportPost","api_endpoint":"https://api.elasticemail.com/v4/contacts/import"},"summary":"Upload Contacts","description":"Upload Contacts | Upload contacts from a file. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/domains":{"get":{"tags":["Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsGet","api_endpoint":"https://api.elasticemail.com/v4/domains"},"summary":"Load Domains","description":"Load Domains | Returns a list of all domains configured for this Account. Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsPost","api_endpoint":"https://api.elasticemail.com/v4/domains"},"summary":"Add Domain","description":"Add Domain | Add new domain to Account. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Domain":{"type":"string","description":"Name of selected domain."},"SetAsDefault":{"type":"boolean","description":"body.SetAsDefault (boolean field from the documented request schema)","enum":[true,false]}}},"example":{"Domain":["example.com"],"SetAsDefault":[false]}}}}}},"/domains/{domain}":{"get":{"tags":["Domains"],"parameters":[{"name":"domain","in":"path","description":"Name of the given domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByDomainGet","api_endpoint":"https://api.elasticemail.com/v4/domains/{domain}"},"summary":"Load Domain","description":"Load Domain | Retrieve a domain configured for this Account. Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Domains"],"parameters":[{"name":"domain","in":"path","description":"Name of the given domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByDomainPut","api_endpoint":"https://api.elasticemail.com/v4/domains/{domain}"},"summary":"Update Domain","description":"Update Domain | Updates the specified domain. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"CertificateStatus":{"type":"string","description":"body.CertificateStatus (string field from the documented request schema)"},"CustomBouncesDomain":{"type":"string","description":"body.CustomBouncesDomain (string field from the documented request schema)"},"IsCustomBouncesDomainDefault":{"type":"boolean","description":"body.IsCustomBouncesDomainDefault (boolean field from the documented request schema)","enum":[true,false]},"VERP":{"type":"boolean","description":"body.VERP (boolean field from the documented request schema)","enum":[true,false]}}},"example":{"CertificateStatus":["ErrorOccured"],"CustomBouncesDomain":["string"],"IsCustomBouncesDomainDefault":[false],"VERP":[false]}}}}},"delete":{"tags":["Domains"],"parameters":[{"name":"domain","in":"path","description":"Name of the given domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByDomainDelete","api_endpoint":"https://api.elasticemail.com/v4/domains/{domain}"},"summary":"Delete Domain","description":"Delete Domain | Deletes configured domain from Account. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/domains/{domain}/restricted":{"get":{"tags":["Domains"],"parameters":[{"name":"domain","in":"path","description":"Name of the given domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByDomainRestrictedGet","api_endpoint":"https://api.elasticemail.com/v4/domains/{domain}/restricted"},"summary":"Check for domain restriction","description":"Check for domain restriction | Checking if domain is from free provider, or restricted. Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/domains/{domain}/verification":{"put":{"tags":["Domains"],"parameters":[{"name":"domain","in":"path","description":"Name of the given domain","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByDomainVerificationPut","api_endpoint":"https://api.elasticemail.com/v4/domains/{domain}/verification"},"summary":"Verify Domain","description":"Verify Domain | Verifies that required DNS records exist for specified domain. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"string","description":"body (request body parameter from the official API reference)","enum":["None","Delete","Http","ExternalHttps","InternalCertHttps","LetsEncryptCert"]}}},"example":{"body":["None"]}}}}}},"/domains/{email}/default":{"patch":{"tags":["Domains"],"parameters":[{"name":"email","in":"path","description":"Default email sender, example: mail@yourdomain.com","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#domainsByEmailDefaultPatch","api_endpoint":"https://api.elasticemail.com/v4/domains/{email}/default"},"summary":"Set Default","description":"Set Default | Sets a verified email address as default sender. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/emails":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#emailsPost","api_endpoint":"https://api.elasticemail.com/v4/emails"},"summary":"Send Bulk Emails","description":"Send Bulk Emails | Send bulk merge email. Required Access Level: SendHttp | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Content":{"type":"object","description":"Proper e-mail content","required":true,"properties":{"AttachFiles":{"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Attachments":{"type":"array","description":"Attachments provided by sending binary data"},"Body":{"type":"array","description":"List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)"},"EnvelopeFrom":{"type":"string","description":"E-mail with an optional name to be used as the envelope from address (e.g.: John Doe )"},"From":{"type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )","required":true},"Headers":{"type":"object","description":"A key-value collection of custom e-mail headers."},"Merge":{"type":"object","description":"A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc."},"Postback":{"type":"string","description":"Postback header."},"ReplyTo":{"type":"string","description":"To what addresses should the recipients reply to (e.g. John Doe )"},"Subject":{"type":"string","description":"Default subject of email."},"TemplateName":{"type":"string","description":"Name of template."},"Utm":{"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."}}},"Options":{"type":"object","description":"E-mail configuration","properties":{"ChannelName":{"type":"string","description":"Name of selected channel."},"Encoding":{"type":"string","description":"Encoding type for the email headers"},"PoolName":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"TimeOffset":{"type":"number","description":"By how long should an e-mail be delayed (in minutes). Maximum is 35 days."},"TrackClicks":{"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TrackOpens":{"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]}}},"Recipients":{"type":"array","description":"List of recipients","required":true,"items":{"type":"object","properties":{"Email":{"type":"string","description":"Proper email address.","required":true},"Fields":{"type":"object","description":"A key-value collection of merge fields which can be used in e-mail body."}}}}}},"example":{"Content":[{"AttachFiles":["preuploaded.jpg"],"Attachments":[{"BinaryContent":"string","ContentType":"string","Name":"string","Size":0}],"Body":[{"Charset":"string","Content":"string","ContentType":"HTML"}],"EnvelopeFrom":"John Doe ","From":"John Doe ","Headers":{"age":"34","city":"New York"},"Merge":{"age":"34","city":"New York"},"Postback":"string","ReplyTo":"John Doe ,John Doe2 ","Subject":"Hello!","TemplateName":"Template01","Utm":{"Campaign":"string","Content":"string","Medium":"string","Source":"string"}}],"Options":[{"ChannelName":"Channel01","Encoding":"UserProvided","PoolName":"My Custom Pool","TimeOffset":0,"TrackClicks":"true","TrackOpens":"true"}],"Recipients":[[{"Email":"mail@example.com","Fields":{"age":"34","city":"New York"}}]]}}}}}},"/emails/{msgid}/view":{"get":{"tags":["Emails"],"parameters":[{"name":"msgid","in":"path","description":"Message identifier","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#emailsByMsgidViewGet","api_endpoint":"https://api.elasticemail.com/v4/emails/{msgid}/view"},"summary":"View Email","description":"View Email | Returns email details for viewing or rendering. Required Access Level: None | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/emails/{transactionid}/status":{"get":{"tags":["Emails"],"parameters":[{"name":"transactionid","in":"path","description":"Transaction identifier","required":true,"schema":{"type":"string","example":""}},{"name":"showAbuse","in":"query","description":"Include Reported as abuse email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showClicked","in":"query","description":"Include Clicked email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showDelivered","in":"query","description":"Include all delivered email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showErrors","in":"query","description":"Include error messages for bounced emails.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showFailed","in":"query","description":"Include Bounced email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showMessageIDs","in":"query","description":"Include all MessageIDs for this transaction","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showOpened","in":"query","description":"Include Opened email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showPending","in":"query","description":"Include Ready to send email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showSent","in":"query","description":"Include Sent email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"showUnsubscribed","in":"query","description":"Include Unsubscribed email addresses.","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#emailsByTransactionidStatusGet","api_endpoint":"https://api.elasticemail.com/v4/emails/{transactionid}/status"},"summary":"Get Status","description":"Get Status | Get status details of an email transaction. Required Access Level: ViewReports | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/emails/mergefile":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#emailsMergefilePost","api_endpoint":"https://api.elasticemail.com/v4/emails/mergefile"},"summary":"Send Bulk Emails CSV","description":"Send Bulk Emails CSV | Send to a list of contacts submitted in a CSV data file. The first column in the CSV must be the email address and the CSV must contain a header row. Additional fields can be included with a named header row and can be merged with the template using {merge} tags in the content.\n \n Example CSV:\n \n email, firstname, lastname\n test1@gmail.com, michael, smith\n test2@gmail.com, janet, smith\n \n Merge file must not be empty. Required Access Level: SendHttp | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Content":{"type":"object","description":"Proper e-mail content","required":true,"properties":{"AttachFiles":{"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Attachments":{"type":"array","description":"Attachments provided by sending binary data"},"Body":{"type":"array","description":"List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)"},"EnvelopeFrom":{"type":"string","description":"E-mail with an optional name to be used as the envelope from address (e.g.: John Doe )"},"From":{"type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )","required":true},"Headers":{"type":"object","description":"A key-value collection of custom e-mail headers."},"Merge":{"type":"object","description":"A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc."},"Postback":{"type":"string","description":"Postback header."},"ReplyTo":{"type":"string","description":"To what addresses should the recipients reply to (e.g. John Doe )"},"Subject":{"type":"string","description":"Default subject of email."},"TemplateName":{"type":"string","description":"Name of template."},"Utm":{"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."}}},"MergeFile":{"type":"object","description":"body.MergeFile (object field from the documented request schema)","required":true,"properties":{"BinaryContent":{"type":"string","description":"File's content as byte array (or a Base64 string)","required":true},"ContentType":{"type":"string","description":"MIME content type"},"Name":{"type":"string","description":"Display name of the file","required":true},"Size":{"type":"number","description":"Size of the attachement in B"}}},"Options":{"type":"object","description":"E-mail configuration","properties":{"ChannelName":{"type":"string","description":"Name of selected channel."},"Encoding":{"type":"string","description":"Encoding type for the email headers"},"PoolName":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"TimeOffset":{"type":"number","description":"By how long should an e-mail be delayed (in minutes). Maximum is 35 days."},"TrackClicks":{"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TrackOpens":{"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]}}}}},"example":{"Content":[{"AttachFiles":["preuploaded.jpg"],"Attachments":[{"BinaryContent":"string","ContentType":"string","Name":"string","Size":0}],"Body":[{"Charset":"string","Content":"string","ContentType":"HTML"}],"EnvelopeFrom":"John Doe ","From":"John Doe ","Headers":{"age":"34","city":"New York"},"Merge":{"age":"34","city":"New York"},"Postback":"string","ReplyTo":"John Doe ,John Doe2 ","Subject":"Hello!","TemplateName":"Template01","Utm":{"Campaign":"string","Content":"string","Medium":"string","Source":"string"}}],"MergeFile":[{"BinaryContent":"string","ContentType":"string","Name":"string","Size":0}],"Options":[{"ChannelName":"Channel01","Encoding":"UserProvided","PoolName":"My Custom Pool","TimeOffset":0,"TrackClicks":"true","TrackOpens":"true"}]}}}}}},"/emails/transactional":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#emailsTransactionalPost","api_endpoint":"https://api.elasticemail.com/v4/emails/transactional"},"summary":"Send Transactional Email","description":"Send Transactional Email | Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Content":{"type":"object","description":"Proper e-mail content","required":true,"properties":{"AttachFiles":{"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Attachments":{"type":"array","description":"Attachments provided by sending binary data"},"Body":{"type":"array","description":"List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)"},"EnvelopeFrom":{"type":"string","description":"E-mail with an optional name to be used as the envelope from address (e.g.: John Doe )"},"From":{"type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )","required":true},"Headers":{"type":"object","description":"A key-value collection of custom e-mail headers."},"Merge":{"type":"object","description":"A key-value collection of custom merge fields, shared between recipients. Should be used in e-mail body like so: {firstname}, {lastname} etc."},"Postback":{"type":"string","description":"Postback header."},"ReplyTo":{"type":"string","description":"To what addresses should the recipients reply to (e.g. John Doe )"},"Subject":{"type":"string","description":"Default subject of email."},"TemplateName":{"type":"string","description":"Name of template."},"Utm":{"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."}}},"Options":{"type":"object","description":"E-mail configuration","properties":{"ChannelName":{"type":"string","description":"Name of selected channel."},"Encoding":{"type":"string","description":"Encoding type for the email headers"},"PoolName":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"TimeOffset":{"type":"number","description":"By how long should an e-mail be delayed (in minutes). Maximum is 35 days."},"TrackClicks":{"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]},"TrackOpens":{"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used.","enum":[true,false]}}},"Recipients":{"type":"object","description":"List of transactional recipients","required":true,"properties":{"BCC":{"type":"array","description":"List of Blind Carbon Copy recipients (hidden from other recipients)"},"CC":{"type":"array","description":"List of Carbon Copy recipients (visible to others)"},"To":{"type":"array","description":"List of recipients (visible to others)","required":true}}}}},"example":{"Content":[{"AttachFiles":["preuploaded.jpg"],"Attachments":[{"BinaryContent":"string","ContentType":"string","Name":"string","Size":0}],"Body":[{"Charset":"string","Content":"string","ContentType":"HTML"}],"EnvelopeFrom":"John Doe ","From":"John Doe ","Headers":{"age":"34","city":"New York"},"Merge":{"age":"34","city":"New York"},"Postback":"string","ReplyTo":"John Doe ,John Doe2 ","Subject":"Hello!","TemplateName":"Template01","Utm":{"Campaign":"string","Content":"string","Medium":"string","Source":"string"}}],"Options":[{"ChannelName":"Channel01","Encoding":"UserProvided","PoolName":"My Custom Pool","TimeOffset":0,"TrackClicks":"true","TrackOpens":"true"}],"Recipients":[{"BCC":["string"],"CC":["string"],"To":["string"]}]}}}}}},"/events":{"get":{"tags":["Events"],"parameters":[{"name":"eventTypes","in":"query","description":"Types of Events to return","required":false,"schema":{"type":"array","example":""}},{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"How many items to load. Maximum for this request is 1000 items","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"orderBy","in":"query","description":"orderBy (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["DateDescending","DateAscending"]}}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsGet","api_endpoint":"https://api.elasticemail.com/v4/events"},"summary":"Load Events","description":"Load Events | Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/events/{transactionid}":{"get":{"tags":["Events"],"parameters":[{"name":"transactionid","in":"path","description":"ID number of transaction","required":true,"schema":{"type":"string","example":""}},{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"orderBy","in":"query","description":"orderBy (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["DateDescending","DateAscending"]}}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsByTransactionidGet","api_endpoint":"https://api.elasticemail.com/v4/events/{transactionid}"},"summary":"Load Email Events","description":"Load Email Events | Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/events/channels/{name}":{"get":{"tags":["Events"],"parameters":[{"name":"name","in":"path","description":"Name of selected channel.","required":true,"schema":{"type":"string","example":""}},{"name":"eventTypes","in":"query","description":"Types of Events to return","required":false,"schema":{"type":"array","example":""}},{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"How many items to load. Maximum for this request is 1000 items","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"orderBy","in":"query","description":"orderBy (query parameter from the official API reference)","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["DateDescending","DateAscending"]}}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsChannelsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/events/channels/{name}"},"summary":"Load Channel Events","description":"Load Channel Events | Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/events/channels/{name}/export":{"post":{"tags":["Events"],"parameters":[{"name":"name","in":"path","description":"Name of selected channel.","required":true,"schema":{"type":"string","example":""}},{"name":"compressionFormat","in":"query","description":"FileResponse compression format. None or Zip.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["None","Zip"]}}},{"name":"eventTypes","in":"query","description":"Types of Events to return","required":false,"schema":{"type":"array","example":""}},{"name":"fileFormat","in":"query","description":"Format of the exported file","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["Csv","Xml","Json"]}}},{"name":"fileName","in":"query","description":"Name of your file including extension.","required":false,"schema":{"type":"string","example":""}},{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsChannelsByNameExportPost","api_endpoint":"https://api.elasticemail.com/v4/events/channels/{name}/export"},"summary":"Export Channel Events","description":"Export Channel Events | Export delivery events log information to the specified file format. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/events/channels/export/{id}/status":{"get":{"tags":["Events"],"parameters":[{"name":"id","in":"path","description":"ID of the exported file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsChannelsExportByIdStatusGet","api_endpoint":"https://api.elasticemail.com/v4/events/channels/export/{id}/status"},"summary":"Check Channel Export Status","description":"Check Channel Export Status | Check the current status of the channel export. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/events/export":{"post":{"tags":["Events"],"parameters":[{"name":"compressionFormat","in":"query","description":"FileResponse compression format. None or Zip.","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["None","Zip"]}}},{"name":"eventTypes","in":"query","description":"Types of Events to return","required":false,"schema":{"type":"array","example":""}},{"name":"fileFormat","in":"query","description":"Format of the exported file","required":false,"schema":{"type":"string","example":"","items":{"type":"string","enum":["Csv","Xml","Json"]}}},{"name":"fileName","in":"query","description":"Name of your file including extension.","required":false,"schema":{"type":"string","example":""}},{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsExportPost","api_endpoint":"https://api.elasticemail.com/v4/events/export"},"summary":"Export Events","description":"Export Events | Export delivery events log information to the specified file format. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/events/export/{id}/status":{"get":{"tags":["Events"],"parameters":[{"name":"id","in":"path","description":"ID of the exported file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#eventsExportByIdStatusGet","api_endpoint":"https://api.elasticemail.com/v4/events/export/{id}/status"},"summary":"Check event export status","description":"Check Export Status | Check the current status of the export. Required Access Level: Export | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/files":{"get":{"tags":["Files"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#filesGet","api_endpoint":"https://api.elasticemail.com/v4/files"},"summary":"List Files","description":"List Files | Returns a list of all your available files. Required Access Level: ViewFiles | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Files"],"parameters":[{"name":"expiresAfterDays","in":"query","description":"After how many days should the file be deleted.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#filesPost","api_endpoint":"https://api.elasticemail.com/v4/files"},"summary":"Upload File","description":"Upload File | Uploads selected file to the server. Required Access Level: ModifyFiles | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BinaryContent":{"type":"string","description":"Content of the file sent as binary data","required":true},"ContentType":{"type":"string","description":"Type of file's content (e.g. image/jpeg)"},"Name":{"type":"string","description":"Filename"}}},"example":{"BinaryContent":["string"],"ContentType":["string"],"Name":["attachment.txt"]}}}}}},"/files/{name}":{"get":{"tags":["Files"],"parameters":[{"name":"name","in":"path","description":"Name of your file including extension.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#filesByNameGet","api_endpoint":"https://api.elasticemail.com/v4/files/{name}"},"summary":"Download File","description":"Download File | Gets content of the specified File. Required Access Level: ViewFiles | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"delete":{"tags":["Files"],"parameters":[{"name":"name","in":"path","description":"Name of your file including extension.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#filesByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/files/{name}"},"summary":"Delete File","description":"Delete File | Permanently deletes the file from your Account. Required Access Level: ModifyFiles | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/{name}/info":{"get":{"tags":["Files"],"parameters":[{"name":"name","in":"path","description":"Name of your file including extension.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#filesByNameInfoGet","api_endpoint":"https://api.elasticemail.com/v4/files/{name}/info"},"summary":"Load File Details","description":"Load File Details | Returns the specified File's details. Required Access Level: ViewFiles | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/inboundroute":{"get":{"tags":["Inbound Routes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundrouteGet","api_endpoint":"https://api.elasticemail.com/v4/inboundroute"},"summary":"Get Routes","description":"Get Routes | Get all your Inbound Routes. Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Inbound Routes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundroutePost","api_endpoint":"https://api.elasticemail.com/v4/inboundroute"},"summary":"Create Route","description":"Create Route | Create new Inbound Route. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ActionType":{"type":"string","description":"body.ActionType (string field from the documented request schema)","required":true},"EmailAddress":{"type":"string","description":"Email to forward the inbound to"},"Filter":{"type":"string","description":"Filter of the inbound data","required":true},"FilterType":{"type":"string","description":"body.FilterType (string field from the documented request schema)","required":true},"HttpAddress":{"type":"string","description":"Address to notify about the inbound"},"Name":{"type":"string","description":"Name of this route","required":true}}},"example":{"ActionType":["ForwardToEmail"],"EmailAddress":["string"],"Filter":["string"],"FilterType":["EmailAddress"],"HttpAddress":["string"],"Name":["string"]}}}}}},"/inboundroute/{id}":{"get":{"tags":["Inbound Routes"],"parameters":[{"name":"id","in":"path","description":"ID number of your attachment","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundrouteByIdGet","api_endpoint":"https://api.elasticemail.com/v4/inboundroute/{id}"},"summary":"Get Route","description":"Get Route | Load an Inbound Route. Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Inbound Routes"],"parameters":[{"name":"id","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundrouteByIdPut","api_endpoint":"https://api.elasticemail.com/v4/inboundroute/{id}"},"summary":"Update Route","description":"Update Route | Update the Inbound Route. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ActionType":{"type":"string","description":"body.ActionType (string field from the documented request schema)","required":true},"EmailAddress":{"type":"string","description":"Email to forward the inbound to"},"Filter":{"type":"string","description":"Filter of the inbound data","required":true},"FilterType":{"type":"string","description":"body.FilterType (string field from the documented request schema)","required":true},"HttpAddress":{"type":"string","description":"Address to notify about the inbound"},"Name":{"type":"string","description":"Name of this route","required":true}}},"example":{"ActionType":["ForwardToEmail"],"EmailAddress":["string"],"Filter":["string"],"FilterType":["EmailAddress"],"HttpAddress":["string"],"Name":["string"]}}}}},"delete":{"tags":["Inbound Routes"],"parameters":[{"name":"id","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundrouteByIdDelete","api_endpoint":"https://api.elasticemail.com/v4/inboundroute/{id}"},"summary":"Delete Route","description":"Delete Route | Deletes the Inbound Route. Required Access Level: ModifySettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/inboundroute/order":{"put":{"tags":["Inbound Routes"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#inboundrouteOrderPut","api_endpoint":"https://api.elasticemail.com/v4/inboundroute/order"},"summary":"Update Sorting","description":"Update Sorting | Required Access Level: ViewSettings | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"array","description":"body (request body parameter from the official API reference)","items":{"type":"object","properties":{"PublicInboundId":{"type":"string","description":"ID of the route to change the order of","required":true},"SortOrder":{"type":"number","description":"1 - route will be used first","required":true}}}}}},"example":{"body":[[{"PublicInboundId":"string","SortOrder":0}]]}}}}}},"/lists":{"get":{"tags":["Lists"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsGet","api_endpoint":"https://api.elasticemail.com/v4/lists"},"summary":"Load Lists","description":"Load Lists | Returns all your existing lists. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Lists"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsPost","api_endpoint":"https://api.elasticemail.com/v4/lists"},"summary":"Add List","description":"Add List | Add a new list. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AllowUnsubscribe":{"type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false","enum":[true,false]},"Emails":{"type":"array","description":"Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts","items":{"type":"string"}},"ListName":{"type":"string","description":"Name of your list.","required":true}}},"example":{"AllowUnsubscribe":["true/false"],"Emails":[["john.doe@sample.com"]],"ListName":["My List 1"]}}}}}},"/lists/{listname}/contacts":{"get":{"tags":["Lists"],"parameters":[{"name":"listname","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByListnameContactsGet","api_endpoint":"https://api.elasticemail.com/v4/lists/{listname}/contacts"},"summary":"Load Contacts in List","description":"Load Contacts in List | Returns a list of contacts. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/lists/{name}":{"get":{"tags":["Lists"],"parameters":[{"name":"name","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/lists/{name}"},"summary":"Load List","description":"Load List | Returns detailed information about specified list. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Lists"],"parameters":[{"name":"name","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByNamePut","api_endpoint":"https://api.elasticemail.com/v4/lists/{name}"},"summary":"Update List","description":"Update List | Update existing list. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AllowUnsubscribe":{"type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false","enum":[true,false]},"NewListName":{"type":"string","description":"Name of your list if you want to change it."}}},"example":{"AllowUnsubscribe":["true/false"],"NewListName":["My List 2"]}}}}},"delete":{"tags":["Lists"],"parameters":[{"name":"name","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/lists/{name}"},"summary":"Delete List","description":"Delete List | Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/lists/{name}/contacts":{"post":{"tags":["Lists"],"parameters":[{"name":"name","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByNameContactsPost","api_endpoint":"https://api.elasticemail.com/v4/lists/{name}/contacts"},"summary":"Add Contacts to List","description":"Add Contacts to List | Add existing Contacts to specified list. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Emails":{"type":"array","description":"Comma delimited list of contact emails","items":{"type":"string"}},"Rule":{"type":"string","description":"SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules"}}},"example":{"Emails":[["john.doe@sample.com"]],"Rule":["string"]}}}}}},"/lists/{name}/contacts/remove":{"post":{"tags":["Lists"],"parameters":[{"name":"name","in":"path","description":"Name of your list.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#listsByNameContactsRemovePost","api_endpoint":"https://api.elasticemail.com/v4/lists/{name}/contacts/remove"},"summary":"Remove Contacts from List","description":"Remove Contacts from List | Remove specified Contacts from your list. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Emails":{"type":"array","description":"Comma delimited list of contact emails","items":{"type":"string"}},"Rule":{"type":"string","description":"SQL-like rule. Sending 'All' as a value loads all resources of the given type. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules"}}},"example":{"Emails":[["john.doe@sample.com"]],"Rule":["string"]}}}}}},"/security/apikeys":{"get":{"tags":["Security"],"parameters":[{"name":"subaccount","in":"query","description":"Email of the subaccount of which ApiKeys should be loaded. The default API key created for the subaccount has a 48-hour expiration period.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securityApikeysGet","api_endpoint":"https://api.elasticemail.com/v4/security/apikeys"},"summary":"List ApiKeys","description":"List ApiKeys | List all your existing ApiKeys. Required Access Level: ViewAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Security"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securityApikeysPost","api_endpoint":"https://api.elasticemail.com/v4/security/apikeys"},"summary":"Add ApiKey","description":"Add ApiKey | Add a new ApiKey. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AccessLevel":{"type":"array","description":"Access level or permission to be assigned to this ApiKey.","required":true,"items":{"type":"string"}},"Expires":{"type":"string","description":"Date this ApiKey expires."},"Name":{"type":"string","description":"Name of the ApiKey for ease of reference.","required":true},"RestrictAccessToIPRange":{"type":"array","description":"Which IPs can use this ApiKey","items":{"type":"string"}},"Subaccount":{"type":"string","description":"Email of the subaccount for which this ApiKey should be created"}}},"example":{"AccessLevel":[["None"]],"Expires":["string"],"Name":["string"],"RestrictAccessToIPRange":[["string"]],"Subaccount":["string"]}}}}}},"/security/apikeys/{name}":{"get":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the ApiKey","required":true,"schema":{"type":"string","example":""}},{"name":"subaccount","in":"query","description":"Email of the subaccount of which ApiKey should be loaded. The default API key created for the subaccount has a 48-hour expiration period.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securityApikeysByNameGet","api_endpoint":"https://api.elasticemail.com/v4/security/apikeys/{name}"},"summary":"Load ApiKey","description":"Load ApiKey | Load your existing ApiKey info. Required Access Level: ViewAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the ApiKey","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securityApikeysByNamePut","api_endpoint":"https://api.elasticemail.com/v4/security/apikeys/{name}"},"summary":"Update ApiKey","description":"Update ApiKey | Update your existing ApiKey. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AccessLevel":{"type":"array","description":"Access level or permission to be assigned to this ApiKey.","required":true,"items":{"type":"string"}},"Expires":{"type":"string","description":"Date this ApiKey expires."},"Name":{"type":"string","description":"Name of the ApiKey for ease of reference.","required":true},"RestrictAccessToIPRange":{"type":"array","description":"Which IPs can use this ApiKey","items":{"type":"string"}},"Subaccount":{"type":"string","description":"Email of the subaccount for which this ApiKey should be created"}}},"example":{"AccessLevel":[["None"]],"Expires":["string"],"Name":["string"],"RestrictAccessToIPRange":[["string"]],"Subaccount":["string"]}}}}},"delete":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the ApiKey","required":true,"schema":{"type":"string","example":""}},{"name":"subaccount","in":"query","description":"Email of the subaccount of which ApiKey should be deleted","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securityApikeysByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/security/apikeys/{name}"},"summary":"Delete ApiKey","description":"Delete ApiKey | Delete your existing ApiKey. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/security/smtp":{"get":{"tags":["Security"],"parameters":[{"name":"subaccount","in":"query","description":"Email of the subaccount of which credentials should be listed","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securitySmtpGet","api_endpoint":"https://api.elasticemail.com/v4/security/smtp"},"summary":"List SMTP Credentials","description":"List SMTP Credentials | List all your existing SMTP Credentials. Required Access Level: ViewAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Security"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securitySmtpPost","api_endpoint":"https://api.elasticemail.com/v4/security/smtp"},"summary":"Add SMTP Credential","description":"Add SMTP Credential | Add new SMTP Credential. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Expires":{"type":"string","description":"Date this SmtpCredential expires."},"Name":{"type":"string","description":"Name of the Credential for ease of reference. It must be a valid email address.","required":true},"RestrictAccessToIPRange":{"type":"array","description":"Which IPs can use this SmtpCredential","items":{"type":"string"}},"Subaccount":{"type":"string","description":"Email of the subaccount for which this SmtpCredential should be created"}}},"example":{"Expires":["string"],"Name":["string"],"RestrictAccessToIPRange":[["string"]],"Subaccount":["string"]}}}}}},"/security/smtp/{name}":{"get":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the SMTP Credential","required":true,"schema":{"type":"string","example":""}},{"name":"subaccount","in":"query","description":"Email of the subaccount of which credential should be loaded","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securitySmtpByNameGet","api_endpoint":"https://api.elasticemail.com/v4/security/smtp/{name}"},"summary":"Load SMTP Credential","description":"Load SMTP Credential | Load your existing SMTP Credential info. Required Access Level: ViewAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the SMTP Credential","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securitySmtpByNamePut","api_endpoint":"https://api.elasticemail.com/v4/security/smtp/{name}"},"summary":"Update SMTP Credential","description":"Update SMTP Credential | Update your existing SMTP Credentials. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Expires":{"type":"string","description":"Date this SmtpCredential expires."},"Name":{"type":"string","description":"Name of the Credential for ease of reference. It must be a valid email address.","required":true},"RestrictAccessToIPRange":{"type":"array","description":"Which IPs can use this SmtpCredential","items":{"type":"string"}},"Subaccount":{"type":"string","description":"Email of the subaccount for which this SmtpCredential should be created"}}},"example":{"Expires":["string"],"Name":["string"],"RestrictAccessToIPRange":[["string"]],"Subaccount":["string"]}}}}},"delete":{"tags":["Security"],"parameters":[{"name":"name","in":"path","description":"Name of the SMTP Credential","required":true,"schema":{"type":"string","example":""}},{"name":"subaccount","in":"query","description":"Email of the subaccount of which credential should be deleted","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#securitySmtpByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/security/smtp/{name}"},"summary":"Delete SMTP Credential","description":"Delete SMTP Credential | Delete your existing SMTP Credentials. Required Access Level: ModifyAccessTokens | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/segments":{"get":{"tags":["Segments"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#segmentsGet","api_endpoint":"https://api.elasticemail.com/v4/segments"},"summary":"Load Segments","description":"Load Segments | Returns a list of all your available Segments. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Segments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#segmentsPost","api_endpoint":"https://api.elasticemail.com/v4/segments"},"summary":"Add Segment","description":"Add Segment | Add a new segment, based on specified RULE. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"Segment name","required":true},"Rule":{"type":"string","description":"SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules","required":true}}},"example":{"Name":["string"],"Rule":["string"]}}}}}},"/segments/{name}":{"get":{"tags":["Segments"],"parameters":[{"name":"name","in":"path","description":"Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#segmentsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/segments/{name}"},"summary":"Load Segment","description":"Load Segment | Returns details for the specified segment. Required Access Level: ViewContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Segments"],"parameters":[{"name":"name","in":"path","description":"Name of your segment.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#segmentsByNamePut","api_endpoint":"https://api.elasticemail.com/v4/segments/{name}"},"summary":"Update Segment","description":"Update Segment | Rename or change RULE for your segment. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"Segment name","required":true},"Rule":{"type":"string","description":"SQL-like rule to determine which Contacts belong to this Segment. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules","required":true}}},"example":{"Name":["string"],"Rule":["string"]}}}}},"delete":{"tags":["Segments"],"parameters":[{"name":"name","in":"path","description":"Name of your segment.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#segmentsByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/segments/{name}"},"summary":"Delete Segment","description":"Delete Segment | Delete an existing segment. Required Access Level: ModifyContacts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/statistics":{"get":{"tags":["Statistics"],"parameters":[{"name":"from","in":"query","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","required":true,"schema":{"type":"string","example":""}},{"name":"to","in":"query","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#statisticsGet","api_endpoint":"https://api.elasticemail.com/v4/statistics"},"summary":"Load Statistics","description":"Load Statistics | Returns basic statistics. Required Access Level: ViewReports | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/statistics/campaigns":{"get":{"tags":["Statistics"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#statisticsCampaignsGet","api_endpoint":"https://api.elasticemail.com/v4/statistics/campaigns"},"summary":"Load Campaigns Stats","description":"Load Campaigns Stats | Returns a list of your Campaigns' stats. Required Access Level: ViewChannels | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/statistics/campaigns/{name}":{"get":{"tags":["Statistics"],"parameters":[{"name":"name","in":"path","description":"The name of the campaign to get.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#statisticsCampaignsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/statistics/campaigns/{name}"},"summary":"Load Campaign Stats","description":"Load Campaign Stats | Retrieve stats of an existing campaign. Required Access Level: ViewChannels | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/statistics/channels":{"get":{"tags":["Statistics"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#statisticsChannelsGet","api_endpoint":"https://api.elasticemail.com/v4/statistics/channels"},"summary":"Load Channels Stats","description":"Load Channels Stats | Returns a list of your Channels' stats. Required Access Level: ViewChannels | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/statistics/channels/{name}":{"get":{"tags":["Statistics"],"parameters":[{"name":"name","in":"path","description":"The name of the channel to get.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#statisticsChannelsByNameGet","api_endpoint":"https://api.elasticemail.com/v4/statistics/channels/{name}"},"summary":"Load Channel Stats","description":"Load Channel Stats | Retrieve an existing channel stats. Required Access Level: ViewChannels | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/subaccounts":{"get":{"tags":["Sub Accounts"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsGet","api_endpoint":"https://api.elasticemail.com/v4/subaccounts"},"summary":"Load SubAccounts","description":"Load SubAccounts | Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Sub Accounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsPost","api_endpoint":"https://api.elasticemail.com/v4/subaccounts"},"summary":"Add SubAccount","description":"Add SubAccount | Add a new SubAccount to your Account. To receive an access token for this SubAccount, make a POST security/apikeys request using the 'subaccount' parameter.\n The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Email":{"type":"string","description":"Proper email address.","required":true},"Password":{"type":"string","description":"Current password.","required":true},"SendActivation":{"type":"boolean","description":"True, if you want to send activation email to this Account to confirm the creation of a new SubAccount. Otherwise, false (SubAccount will immediately be Active).","enum":[true,false]},"Settings":{"type":"object","description":"SubAccount settings","properties":{"Email":{"type":"object","description":"Settings related to sending emails"}}}}},"example":{"Email":["mail@example.com"],"Password":["********"],"SendActivation":[false],"Settings":[{"Email":{"DailySendLimit":"100000","EmailSizeLimit":"10","EnablePrivateIPPurchase":false,"MaxContacts":0,"PoolName":"My Custom Pool","RequiresEmailCredits":"true","ValidSenderDomainOnly":false}}]}}}}}},"/subaccounts/{email}":{"get":{"tags":["Sub Accounts"],"parameters":[{"name":"email","in":"path","description":"Email address of Sub-Account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsByEmailGet","api_endpoint":"https://api.elasticemail.com/v4/subaccounts/{email}"},"summary":"Load SubAccount","description":"Load SubAccount | Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"delete":{"tags":["Sub Accounts"],"parameters":[{"name":"email","in":"path","description":"Email address of Sub-Account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsByEmailDelete","api_endpoint":"https://api.elasticemail.com/v4/subaccounts/{email}"},"summary":"Delete SubAccount","description":"Delete SubAccount | Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/subaccounts/{email}/apikey":{"get":{"tags":["Sub Accounts"],"parameters":[{"name":"email","in":"path","description":"Email address of Sub-Account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsByEmailApikeyGet","api_endpoint":"https://api.elasticemail.com/v4/subaccounts/{email}/apikey"},"summary":"Get SubAccount ApiKey","description":"Get SubAccount ApiKey | Returns API key token for the specified SubAccount.\n The default API key created for the subaccount has a 48-hour expiration period. Required Access Level: ModifySubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/subaccounts/{email}/credits":{"patch":{"tags":["Sub Accounts"],"parameters":[{"name":"email","in":"path","description":"Email address of Sub-Account","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsByEmailCreditsPatch","api_endpoint":"https://api.elasticemail.com/v4/subaccounts/{email}/credits"},"summary":"Add, Subtract Email Credits","description":"Add, Subtract Email Credits | Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Credits":{"type":"number","description":"Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool.","required":true},"Notes":{"type":"string","description":"Note to append to this credits change, for history."}}},"example":{"Credits":[0],"Notes":["string"]}}}}}},"/subaccounts/{email}/settings/email":{"put":{"tags":["Sub Accounts"],"parameters":[{"name":"email","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#subaccountsByEmailSettingsEmailPut","api_endpoint":"https://api.elasticemail.com/v4/subaccounts/{email}/settings/email"},"summary":"Update SubAccount Email Settings","description":"Update SubAccount Email Settings | Update SubAccount email settings. Required Access Level: ModifySubAccounts | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DailySendLimit":{"type":"number","description":"Amount of emails Account can send daily"},"EmailSizeLimit":{"type":"number","description":"Maximum size of email including attachments in MB's"},"EnablePrivateIPPurchase":{"type":"boolean","description":"Can the SubAccount purchase Private IP for themselves","enum":[true,false]},"MaxContacts":{"type":"number","description":"Maximum number of contacts the Account can have. 0 means that parent account's limit is used."},"MonthlyRefillCredits":{"type":"number","description":"Amount of credits added to Account automatically"},"PoolName":{"type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"RequiresEmailCredits":{"type":"boolean","description":"True, if Account needs credits to send emails. Otherwise, false","enum":[true,false]},"ValidSenderDomainOnly":{"type":"boolean","description":"body.ValidSenderDomainOnly (boolean field from the documented request schema)","enum":[true,false]}}},"example":{"DailySendLimit":["100000"],"EmailSizeLimit":["10"],"EnablePrivateIPPurchase":[false],"MaxContacts":[0],"MonthlyRefillCredits":["1000"],"PoolName":["My Custom Pool"],"RequiresEmailCredits":["true"],"ValidSenderDomainOnly":[false]}}}}}},"/suppressions":{"get":{"tags":["Suppressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsGet","api_endpoint":"https://api.elasticemail.com/v4/suppressions"},"summary":"Get Suppressions","description":"Get Suppressions | Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/suppressions/{email}":{"get":{"tags":["Suppressions"],"parameters":[{"name":"email","in":"path","description":"Proper email address.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsByEmailGet","api_endpoint":"https://api.elasticemail.com/v4/suppressions/{email}"},"summary":"Get Suppression","description":"Get Suppression | Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"delete":{"tags":["Suppressions"],"parameters":[{"name":"email","in":"path","description":"Proper email address.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsByEmailDelete","api_endpoint":"https://api.elasticemail.com/v4/suppressions/{email}"},"summary":"Delete Suppression","description":"Delete Suppression | Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/suppressions/bounces":{"get":{"tags":["Suppressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Text fragment used for searching.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsBouncesGet","api_endpoint":"https://api.elasticemail.com/v4/suppressions/bounces"},"summary":"Get Bounce List","description":"Get Bounce List | Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsBouncesPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/bounces"},"summary":"Add Bounces","description":"Add Bounces | Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"array","description":"body (request body parameter from the official API reference)","items":{"type":"string"}}}},"example":{"body":[["string"]]}}}}}},"/suppressions/bounces/import":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsBouncesImportPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/bounces/import"},"summary":"Add Bounces Async","description":"Add Bounces Async | Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/suppressions/complaints":{"get":{"tags":["Suppressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Text fragment used for searching.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsComplaintsGet","api_endpoint":"https://api.elasticemail.com/v4/suppressions/complaints"},"summary":"Get Complaints List","description":"Get Complaints List | Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsComplaintsPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/complaints"},"summary":"Add Complaints","description":"Add Complaints | Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"array","description":"body (request body parameter from the official API reference)","items":{"type":"string"}}}},"example":{"body":[["string"]]}}}}}},"/suppressions/complaints/import":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsComplaintsImportPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/complaints/import"},"summary":"Add Complaints Async","description":"Add Complaints Async | Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/suppressions/unsubscribes":{"get":{"tags":["Suppressions"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"search","in":"query","description":"Text fragment used for searching.","required":false,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsUnsubscribesGet","api_endpoint":"https://api.elasticemail.com/v4/suppressions/unsubscribes"},"summary":"Get Unsubscribes List","description":"Get Unsubscribes List | Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsUnsubscribesPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/unsubscribes"},"summary":"Add Unsubscribes","description":"Add Unsubscribes | Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"body":{"type":"array","description":"body (request body parameter from the official API reference)","items":{"type":"string"}}}},"example":{"body":[["string"]]}}}}}},"/suppressions/unsubscribes/import":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#suppressionsUnsubscribesImportPost","api_endpoint":"https://api.elasticemail.com/v4/suppressions/unsubscribes/import"},"summary":"Add Unsubscribes Async","description":"Add Unsubscribes Async | Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/templates":{"get":{"tags":["Templates"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}},{"name":"scopeType","in":"query","description":"Return templates with specified scope only","required":true,"schema":{"type":"array","example":""}},{"name":"templateTypes","in":"query","description":"Return templates with specified type only","required":false,"schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#templatesGet","api_endpoint":"https://api.elasticemail.com/v4/templates"},"summary":"Load Templates","description":"Load Templates | Returns a list of templates for the specified type. Required Access Level: ViewTemplates | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#templatesPost","api_endpoint":"https://api.elasticemail.com/v4/templates"},"summary":"Add Template","description":"Add Template | Add a new Template. Required Access Level: ModifyTemplates | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Body":{"type":"array","description":"Email content of this template","items":{"type":"object","properties":{"Charset":{"type":"string","description":"Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more..."},"Content":{"type":"string","description":"Actual content of the body part"},"ContentType":{"type":"string","description":"Type of body part","required":true}}}},"Name":{"type":"string","description":"Template name","required":true},"Subject":{"type":"string","description":"Default subject of email."},"TemplateScope":{"type":"string","description":"Visibility of a template"}}},"example":{"Body":[[{"Charset":"string","Content":"string","ContentType":"HTML"}]],"Name":["string"],"Subject":["Hello!"],"TemplateScope":["Personal"]}}}}}},"/templates/{name}":{"get":{"tags":["Templates"],"parameters":[{"name":"name","in":"path","description":"Name of template.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#templatesByNameGet","api_endpoint":"https://api.elasticemail.com/v4/templates/{name}"},"summary":"Load Template","description":"Load Template | Load detailed information of the specified template. Required Access Level: ViewTemplates | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Templates"],"parameters":[{"name":"name","in":"path","description":"Name of template.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#templatesByNamePut","api_endpoint":"https://api.elasticemail.com/v4/templates/{name}"},"summary":"Update Template","description":"Update Template | Update existing template, overwriting existing data. Required Access Level: ModifyTemplates | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Body":{"type":"array","description":"Email content of this template","items":{"type":"object","properties":{"Charset":{"type":"string","description":"Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more..."},"Content":{"type":"string","description":"Actual content of the body part"},"ContentType":{"type":"string","description":"Type of body part","required":true}}}},"Name":{"type":"string","description":"Template name","required":true},"Subject":{"type":"string","description":"Default subject of email."},"TemplateScope":{"type":"string","description":"Visibility of a template"}}},"example":{"Body":[[{"Charset":"string","Content":"string","ContentType":"HTML"}]],"Name":["string"],"Subject":["Hello!"],"TemplateScope":["Personal"]}}}}},"delete":{"tags":["Templates"],"parameters":[{"name":"name","in":"path","description":"Name of template.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#templatesByNameDelete","api_endpoint":"https://api.elasticemail.com/v4/templates/{name}"},"summary":"Delete Template","description":"Delete Template | Delete template with the specified name. Required Access Level: ModifyTemplates | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/verifications":{"get":{"tags":["Verifications"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsGet","api_endpoint":"https://api.elasticemail.com/v4/verifications"},"summary":"Get Emails Verification Results","description":"Get Emails Verification Results | Returns a results of all verified single emails. Required Access Level: ViewVerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/verifications/{email}":{"get":{"tags":["Verifications"],"parameters":[{"name":"email","in":"path","description":"Email address to view verification result of","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsByEmailGet","api_endpoint":"https://api.elasticemail.com/v4/verifications/{email}"},"summary":"Get Email Verification Result","description":"Get Email Verification Result | Returns a result of verified email. Required Access Level: ViewVerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Verifications"],"parameters":[{"name":"email","in":"path","description":"Email address to verify","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsByEmailPost","api_endpoint":"https://api.elasticemail.com/v4/verifications/{email}"},"summary":"Verify Email","description":"Verify Email | Verify single email address and returns result of verification. Required Access Level: VerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Verifications"],"parameters":[{"name":"email","in":"path","description":"Email address to verification","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsByEmailDelete","api_endpoint":"https://api.elasticemail.com/v4/verifications/{email}"},"summary":"Delete Email Verification Result","description":"Delete Email Verification Result | Delete a result with given email if exists. Required Access Level: VerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/verifications/files":{"post":{"tags":["Verifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesPost","api_endpoint":"https://api.elasticemail.com/v4/verifications/files"},"summary":"Upload File with Emails","description":"Upload File with Emails | Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","description":"body.file (string field from the documented request schema)"}}},"example":{"file":["string"]}}}}}},"/verifications/files/{id}":{"delete":{"tags":["Verifications"],"parameters":[{"name":"id","in":"path","description":"ID of the exported file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesByIdDelete","api_endpoint":"https://api.elasticemail.com/v4/verifications/files/{id}"},"summary":"Delete File Verification Result","description":"Delete File Verification Result | Delete Verification Results if they exist. Required Access Level: VerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/verifications/files/{id}/result":{"get":{"tags":["Verifications"],"parameters":[{"name":"id","in":"path","description":"ID of the Verification to display status of","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of returned email verification results","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many result items should be returned ahead","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesByIdResultGet","api_endpoint":"https://api.elasticemail.com/v4/verifications/files/{id}/result"},"summary":"Get Detailed File Verification Result","description":"Get Detailed File Verification Result | Returns status and results (if verified) of file with given ID. Required Access Level: ViewVerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/verifications/files/{id}/result/download":{"get":{"tags":["Verifications"],"parameters":[{"name":"id","in":"path","description":"Verification ID to download","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesByIdResultDownloadGet","api_endpoint":"https://api.elasticemail.com/v4/verifications/files/{id}/result/download"},"summary":"Download File Verification Result","description":"Download File Verification Result | Download verification results as a ZIP file. Required Access Level: ViewVerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/verifications/files/{id}/verification":{"post":{"tags":["Verifications"],"parameters":[{"name":"id","in":"path","description":"File ID to start verification","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesByIdVerificationPost","api_endpoint":"https://api.elasticemail.com/v4/verifications/files/{id}/verification"},"summary":"Start verification","description":"Start verification | Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/verifications/files/result":{"get":{"tags":["Verifications"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#verificationsFilesResultGet","api_endpoint":"https://api.elasticemail.com/v4/verifications/files/result"},"summary":"Get Files Verification Results","description":"Get Files Verification Results | Returns a list of uploaded files, their statuses and results. Required Access Level: ViewVerifyEmails | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]}},"/webhook":{"get":{"tags":["Webhooks"],"parameters":[{"name":"limit","in":"query","description":"Maximum number of returned items.","required":false,"schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"How many items should be returned ahead.","required":false,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#webhookGet","api_endpoint":"https://api.elasticemail.com/v4/webhook"},"summary":"Load Webhooks","description":"Load Webhooks | Returns a list of notification webhooks. Required Access Level: ViewWebNotifications | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#webhookPost","api_endpoint":"https://api.elasticemail.com/v4/webhook"},"summary":"Add Webhook","description":"Add Webhook | Add a notification webhook. Required Access Level: ModifyWebNotifications | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Name":{"type":"string","description":"Filename","required":true},"NotificationForAbuseReport":{"type":"boolean","description":"body.NotificationForAbuseReport (boolean field from the documented request schema)","enum":[true,false]},"NotificationForClicked":{"type":"boolean","description":"body.NotificationForClicked (boolean field from the documented request schema)","enum":[true,false]},"NotificationForError":{"type":"boolean","description":"body.NotificationForError (boolean field from the documented request schema)","enum":[true,false]},"NotificationForOpened":{"type":"boolean","description":"body.NotificationForOpened (boolean field from the documented request schema)","enum":[true,false]},"NotificationForSent":{"type":"boolean","description":"body.NotificationForSent (boolean field from the documented request schema)","enum":[true,false]},"NotificationForUnsubscribed":{"type":"boolean","description":"body.NotificationForUnsubscribed (boolean field from the documented request schema)","enum":[true,false]},"NotifyOncePerEmail":{"type":"boolean","description":"body.NotifyOncePerEmail (boolean field from the documented request schema)","enum":[true,false]},"URL":{"type":"string","description":"URL of notification.","required":true}}},"example":{"Name":["attachment.txt"],"NotificationForAbuseReport":[false],"NotificationForClicked":[false],"NotificationForError":[false],"NotificationForOpened":[false],"NotificationForSent":[false],"NotificationForUnsubscribed":[false],"NotifyOncePerEmail":[false],"URL":["http://address.for.notification.com"]}}}}}},"/webhook/{publicid}":{"get":{"tags":["Webhooks"],"parameters":[{"name":"publicid","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#webhookByPublicidGet","api_endpoint":"https://api.elasticemail.com/v4/webhook/{publicid}"},"summary":"Load Webhook","description":"Load Webhook | Load notifications webhook details. Required Access Level: ViewWebNotifications | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}]},"put":{"tags":["Webhooks"],"parameters":[{"name":"publicid","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#webhookByPublicidPut","api_endpoint":"https://api.elasticemail.com/v4/webhook/{publicid}"},"summary":"Update Webhook","description":"Update Webhook | Update notification webhook. Required Access Level: ModifyWebNotifications | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"IsEnabled":{"type":"boolean","description":"body.IsEnabled (boolean field from the documented request schema)","enum":[true,false]},"Name":{"type":"string","description":"Filename"},"NotificationForAbuseReport":{"type":"boolean","description":"body.NotificationForAbuseReport (boolean field from the documented request schema)","enum":[true,false]},"NotificationForClicked":{"type":"boolean","description":"body.NotificationForClicked (boolean field from the documented request schema)","enum":[true,false]},"NotificationForError":{"type":"boolean","description":"body.NotificationForError (boolean field from the documented request schema)","enum":[true,false]},"NotificationForOpened":{"type":"boolean","description":"body.NotificationForOpened (boolean field from the documented request schema)","enum":[true,false]},"NotificationForSent":{"type":"boolean","description":"body.NotificationForSent (boolean field from the documented request schema)","enum":[true,false]},"NotificationForUnsubscribed":{"type":"boolean","description":"body.NotificationForUnsubscribed (boolean field from the documented request schema)","enum":[true,false]},"NotifyOncePerEmail":{"type":"boolean","description":"body.NotifyOncePerEmail (boolean field from the documented request schema)","enum":[true,false]},"URL":{"type":"string","description":"URL of notification."}}},"example":{"IsEnabled":[false],"Name":["attachment.txt"],"NotificationForAbuseReport":[false],"NotificationForClicked":[false],"NotificationForError":[false],"NotificationForOpened":[false],"NotificationForSent":[false],"NotificationForUnsubscribed":[false],"NotifyOncePerEmail":[false],"URL":["http://address.for.notification.com"]}}}}},"delete":{"tags":["Webhooks"],"parameters":[{"name":"publicid","in":"path","description":"string","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://elasticemail.com/developers/rest-api#webhookByPublicidDelete","api_endpoint":"https://api.elasticemail.com/v4/webhook/{publicid}"},"summary":"Delete Webhook","description":"Delete Webhook | Delete the specified notifications webhook. Required Access Level: ModifyWebNotifications | Source: official OpenAPI spec at https://elasticemail.com/developers/rest-api/","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}