{"openapi":"3.0.3","info":{"version":"4.0.0","contact":{"email":"support@elasticemail.com"},"license":{"name":"MIT","url":"https://opensource.org/licenses/MIT"},"description":"This API is based on the REST API architecture, allowing the user to easily manage their data with this resource-based approach.\r\n\r\nEvery API call is established on which specific request type (GET, POST, PUT, DELETE) will be used.\r\n\r\nThe API has a limit of 20 concurrent connections and a hard timeout of 600 seconds per request.\r\n\r\nTo start using this API, you will need your Access Token (available here). Remember to keep it safe. Required access levels are listed in the given request’s description.\r\n\r\nDownloadable library clients can be found in our Github repository here","termsOfService":"https://elasticemail.com/resources/usage-policies/terms-of-use/","title":"Elastic Email REST API"},"servers":[{"url":"https://api.elasticemail.com/v4"}],"tags":[{"description":"Sending and monitoring progress of your Campaigns","name":"Campaigns"},{"description":"Methods used to manage your Contacts.","name":"Contacts"},{"description":"Send your emails and see their statuses","name":"Emails"},{"description":"Methods to check logs of your campaigns","name":"Events"},{"description":"Manage the files on your account to be used as attachments in your email, templates, etc.","name":"Files"},{"description":"Inbounds operations","name":"InboundRoute"},{"description":"API methods for managing your Lists","name":"Lists"},{"description":"Security methods","name":"Security"},{"description":"Manages your segments - dynamically created lists of contacts. Help for building a segment rule can be found here: https://help.elasticemail.com/en/articles/5162182-segment-rules","name":"Segments"},{"description":"Methods to check logs of your campaigns","name":"Statistics"},{"description":"Manage your subaccounts","name":"SubAccounts"},{"description":"Methods used to manage your Suppressions.","name":"Suppressions"},{"description":"Managing and editing templates of your emails","name":"Templates"},{"description":"Verify emails and read the results","name":"Verifications"}],"paths":{"/campaigns":{"get":{"tags":["Campaigns"],"summary":"Load Campaigns","description":"Returns a list all of your campaigns. Limited to 1000 results. Required Access Level: ViewCampaigns","operationId":"campaignsGet","parameters":[{"name":"search","description":"Text fragment used for searching in Campaign name (using the 'contains' rule)","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Campaign"},"type":"array"}}}}}},"post":{"tags":["Campaigns"],"summary":"Add Campaign","description":"Add a campaign for processing. Required Access Level: ModifyCampaigns","operationId":"campaignsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}},"description":"JSON representation of a campaign","required":true}}},"/campaigns/{name}":{"get":{"tags":["Campaigns"],"summary":"Load Campaign","description":"Returns the specified campaign details. Required Access Level: ViewCampaigns","operationId":"campaignsByNameGet","parameters":[{"name":"name","description":"Name of Campaign to get","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}}},"put":{"tags":["Campaigns"],"summary":"Update Campaign","description":"Updates a previously added campaign. Only Active and Paused campaigns can be updated. Required Access Level: ModifyCampaigns","operationId":"campaignsByNamePut","parameters":[{"name":"name","description":"Name of Campaign to update","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Campaign"}}},"description":"JSON representation of a campaign","required":true}},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign","description":"Delete the specific campaign. This does not cancel in progress email, see Cancel In Progress. Required Access Level: ModifyCampaigns","operationId":"campaignsByNameDelete","parameters":[{"name":"name","description":"Name of Campaign to delete","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/campaigns/{name}/pause":{"put":{"tags":["Campaigns"],"summary":"Pause Campaign","description":"Pauses the specific campaign, cancelling emails that are waiting to be sent. Required Access Level: ModifyCampaigns","operationId":"campaignsByNamePausePut","parameters":[{"name":"name","description":"Name of Campaign to pause","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/contacts":{"get":{"tags":["Contacts"],"summary":"Load Contacts","description":"Returns a list of contacts. Required Access Level: ViewContacts","operationId":"contactsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"20","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}}},"post":{"tags":["Contacts"],"summary":"Add Contact","description":"Add new Contacts to your Lists. Up to 1000 can be added (for more please refer to the import request). Required Access Level: ModifyContacts","operationId":"contactsPost","parameters":[{"name":"listnames","description":"Names of lists to which the uploaded contacts should be added to","in":"query","required":false,"schema":{"items":{"format":"string","type":"string"},"type":"array","description":"array"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactPayload"},"type":"array"}}},"required":true}}},"/contacts/{email}":{"get":{"tags":["Contacts"],"summary":"Load Contact","description":"Load detailed contact information for specified email. Required Access Level: ViewContacts","operationId":"contactsByEmailGet","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}}},"put":{"tags":["Contacts"],"summary":"Update Contact","description":"Update selected contact. Omitted contact's fields will not be changed. Required Access Level: ModifyContacts","operationId":"contactsByEmailPut","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdatePayload"}}},"required":true}},"delete":{"tags":["Contacts"],"summary":"Delete Contact","description":"Deletes the provided contact. Required Access Level: ModifyContacts","operationId":"contactsByEmailDelete","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/contacts/delete":{"post":{"tags":["Contacts"],"summary":"Delete Contacts Bulk","description":"Deletes provided contacts in bulk. Required Access Level: ModifyContacts","operationId":"contactsDeletePost","responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/contacts/export":{"post":{"tags":["Contacts"],"summary":"Export Contacts","description":"Request an Export of specified Contacts. Required Access Level: Export","operationId":"contactsExportPost","parameters":[{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"rule","description":"Query used for filtering.","in":"query","required":false,"schema":{"example":"Status%20=%20Engaged","format":"string","type":"string","description":"string"}},{"name":"emails","description":"Comma delimited list of contact emails","in":"query","required":false,"schema":{"example":["mail@contact.com,mail1@contact.com,mail2@contact.com"],"items":{"format":"string","type":"string"},"type":"array","description":"array"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/contacts/export/{id}/status":{"get":{"tags":["Contacts"],"summary":"Check Export Status","description":"Check the current status of the export. Required Access Level: Export","operationId":"contactsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/contacts/import":{"post":{"tags":["Contacts"],"summary":"Upload Contacts","description":"Upload contacts from a file. Required Access Level: ModifyContacts","operationId":"contactsImportPost","parameters":[{"name":"listName","description":"Name of an existing list to add these contacts to","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"encodingName","description":"In what encoding the file is uploaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}},{"name":"fileUrl","description":"Optional url of csv to import","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"File in CSV format with columns to upload as Contact fields. Required columns: Email. Suggested columns: AllowUnsubscribe, Status, ConsentDate, ConsentIP, ConsentTracking.","required":true}}},"/emails":{"post":{"tags":["Emails"],"summary":"Send Bulk Emails","description":"Send bulk merge email. Required Access Level: SendHttp","operationId":"emailsPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailMessageData"}}},"description":"Email data","required":true}}},"/emails/{msgid}/view":{"get":{"tags":["Emails"],"summary":"View Email","description":"Returns email details for viewing or rendering. Required Access Level: None","operationId":"emailsByMsgidViewGet","parameters":[{"name":"msgid","description":"Message identifier","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailData"}}}}}}},"/emails/{transactionid}/status":{"get":{"tags":["Emails"],"summary":"Get Status","description":"Get status details of an email transaction. Required Access Level: ViewReports","operationId":"emailsByTransactionidStatusGet","parameters":[{"name":"transactionid","description":"Transaction identifier","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"showFailed","description":"Include Bounced email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showSent","description":"Include Sent email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showDelivered","description":"Include all delivered email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showPending","description":"Include Ready to send email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showOpened","description":"Include Opened email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showClicked","description":"Include Clicked email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showAbuse","description":"Include Reported as abuse email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showUnsubscribed","description":"Include Unsubscribed email addresses.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showErrors","description":"Include error messages for bounced emails.","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}},{"name":"showMessageIDs","description":"Include all MessageIDs for this transaction","in":"query","required":false,"schema":{"default":"False","format":"boolean","type":"boolean","description":"boolean"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailJobStatus"}}}}}}},"/emails/mergefile":{"post":{"tags":["Emails"],"summary":"Send Bulk Emails CSV","description":"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","operationId":"emailsMergefilePost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeEmailPayload"}}},"description":"Email data","required":true}}},"/emails/transactional":{"post":{"tags":["Emails"],"summary":"Send Transactional Email","description":"Send transactional emails (recipients will be known to each other). Required Access Level: SendHttp","operationId":"emailsTransactionalPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailSend"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailTransactionalMessageData"}}},"description":"Email data","required":true}}},"/events":{"get":{"tags":["Events"],"summary":"Load Events","description":"Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports","operationId":"eventsGet","parameters":[{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"How many items to load. Maximum for this request is 1000 items","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/{transactionid}":{"get":{"tags":["Events"],"summary":"Load Email Events","description":"Returns a log of delivery events for the specific transaction ID. Required Access Level: ViewReports","operationId":"eventsByTransactionidGet","parameters":[{"name":"transactionid","description":"ID number of transaction","in":"path","required":true,"schema":{"example":"TransactionID","format":"string","type":"string","description":"string"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/channels/{name}":{"get":{"tags":["Events"],"summary":"Load Channel Events","description":"Returns a log of delivery events filtered by specified parameters. Required Access Level: ViewReports","operationId":"eventsChannelsByNameGet","parameters":[{"name":"name","description":"Name of selected channel.","in":"path","required":true,"schema":{"example":"Channel01","format":"string","type":"string","description":"string"}},{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"orderBy","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EventsOrderBy"}},{"name":"limit","description":"How many items to load. Maximum for this request is 1000 items","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RecipientEvent"},"type":"array"}}}}}}},"/events/channels/{name}/export":{"post":{"tags":["Events"],"summary":"Export Channel Events","description":"Export delivery events log information to the specified file format. Required Access Level: Export","operationId":"eventsChannelsByNameExportPost","parameters":[{"name":"name","description":"Name of selected channel.","in":"path","required":true,"schema":{"example":"Channel01","format":"string","type":"string","description":"string"}},{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/events/channels/export/{id}/status":{"get":{"tags":["Events"],"summary":"Check Channel Export Status","description":"Check the current status of the channel export. Required Access Level: Export","operationId":"eventsChannelsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/events/export":{"post":{"tags":["Events"],"summary":"Export Events","description":"Export delivery events log information to the specified file format. Required Access Level: Export","operationId":"eventsExportPost","parameters":[{"name":"eventTypes","description":"Types of Events to return","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/EventType"},"type":"array","description":"array"}},{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}},{"name":"fileFormat","description":"Format of the exported file","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ExportFileFormats"}},{"name":"compressionFormat","description":"FileResponse compression format. None or Zip.","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CompressionFormat"}},{"name":"fileName","description":"Name of your file including extension.","in":"query","required":false,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportLink"}}}}}}},"/events/export/{id}/status":{"get":{"tags":["Events"],"summary":"Check Export Status","description":"Check the current status of the export. Required Access Level: Export","operationId":"eventsExportByIdStatusGet","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExportStatus"}}}}}}},"/files":{"get":{"tags":["Files"],"summary":"List Files","description":"Returns a list of all your available files. Required Access Level: ViewFiles","operationId":"filesGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/FileInfo"},"type":"array"}}}}}},"post":{"tags":["Files"],"summary":"Upload File","description":"Uploads selected file to the server. Required Access Level: ModifyFiles","operationId":"filesPost","parameters":[{"name":"expiresAfterDays","description":"After how many days should the file be deleted.","in":"query","required":false,"schema":{"default":"35","example":null,"format":"int32","nullable":true,"type":"integer","description":"integer"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FilePayload"}}},"required":true}}},"/files/{name}":{"get":{"tags":["Files"],"summary":"Download File","description":"Gets content of the specified File. Required Access Level: ViewFiles","operationId":"filesByNameGet","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/*":{"schema":{"format":"binary","type":"string"}}}}}},"delete":{"tags":["Files"],"summary":"Delete File","description":"Permanently deletes the file from your Account. Required Access Level: ModifyFiles","operationId":"filesByNameDelete","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/files/{name}/info":{"get":{"tags":["Files"],"summary":"Load File Details","description":"Returns the specified File's details. Required Access Level: ViewFiles","operationId":"filesByNameInfoGet","parameters":[{"name":"name","description":"Name of your file including extension.","in":"path","required":true,"schema":{"example":"filename.txt","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FileInfo"}}}}}}},"/inboundroute":{"get":{"tags":["InboundRoute"],"summary":"Get Routes","description":"Get all your Inbound Routes. Required Access Level: ViewSettings","operationId":"inboundrouteGet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InboundRoute"},"type":"array"}}}}}},"post":{"tags":["InboundRoute"],"summary":"Create Route","description":"Create new Inbound Route. Required Access Level: ModifySettings","operationId":"inboundroutePost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundPayload"}}},"required":true}}},"/inboundroute/{id}":{"get":{"tags":["InboundRoute"],"summary":"Get Route","description":"Load an Inbound Route. Required Access Level: ViewSettings","operationId":"inboundrouteByIdGet","parameters":[{"name":"id","description":"ID number of your attachment","in":"path","required":true,"schema":{"example":"123456","format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}}},"put":{"tags":["InboundRoute"],"summary":"Update Route","description":"Update the Inbound Route. Required Access Level: ModifySettings","operationId":"inboundrouteByIdPut","parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundRoute"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InboundPayload"}}},"required":true}},"delete":{"tags":["InboundRoute"],"summary":"Delete Route","description":"Deletes the Inbound Route. Required Access Level: ModifySettings","operationId":"inboundrouteByIdDelete","parameters":[{"name":"id","in":"path","required":true,"schema":{"format":"guid","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/inboundroute/order":{"put":{"tags":["InboundRoute"],"summary":"Update Sorting","description":"Required Access Level: ViewSettings","operationId":"inboundrouteOrderPut","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/InboundRoute"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SortOrderItem"},"type":"array"}}},"description":"Change the ordering of inbound routes for when matching the inbound","required":true}}},"/lists":{"get":{"tags":["Lists"],"summary":"Load Lists","description":"Returns all your existing lists. Required Access Level: ViewContacts","operationId":"listsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ContactsList"},"type":"array"}}}}}},"post":{"tags":["Lists"],"summary":"Add List","description":"Add a new list. Required Access Level: ModifyContacts","operationId":"listsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPayload"}}},"required":true}}},"/lists/{listname}/contacts":{"get":{"tags":["Lists"],"summary":"Load Contacts in List","description":"Returns a list of contacts. Required Access Level: ViewContacts","operationId":"listsByListnameContactsGet","parameters":[{"name":"listname","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"20","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Contact"},"type":"array"}}}}}}},"/lists/{name}":{"get":{"tags":["Lists"],"summary":"Load List","description":"Returns detailed information about specified list. Required Access Level: ViewContacts","operationId":"listsByNameGet","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}}},"put":{"tags":["Lists"],"summary":"Update List","description":"Update existing list. Required Access Level: ModifyContacts","operationId":"listsByNamePut","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListUpdatePayload"}}},"required":true}},"delete":{"tags":["Lists"],"summary":"Delete List","description":"Deletes List and removes all the Contacts from it (does not delete Contacts). Required Access Level: ModifyContacts","operationId":"listsByNameDelete","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/lists/{name}/contacts":{"post":{"tags":["Lists"],"summary":"Add Contacts to List","description":"Add existing Contacts to specified list. Required Access Level: ModifyContacts","operationId":"listsByNameContactsPost","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactsList"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/lists/{name}/contacts/remove":{"post":{"tags":["Lists"],"summary":"Remove Contacts from List","description":"Remove specified Contacts from your list. Required Access Level: ModifyContacts","operationId":"listsByNameContactsRemovePost","parameters":[{"name":"name","description":"Name of your list.","in":"path","required":true,"schema":{"example":"My List 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailsPayload"}}},"description":"Provide either rule or a list of emails, not both.","required":true}}},"/security/apikeys":{"get":{"tags":["Security"],"summary":"List ApiKeys","description":"List all your existing ApiKeys. Required Access Level: Security","operationId":"securityApikeysGet","parameters":[{"name":"subaccount","description":"Email of the subaccount of which ApiKeys should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ApiKey"},"type":"array"}}}}}},"post":{"tags":["Security"],"summary":"Add ApiKey","description":"Add a new ApiKey. Required Access Level: Security","operationId":"securityApikeysPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewApiKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPayload"}}},"required":true}}},"/security/apikeys/{name}":{"get":{"tags":["Security"],"summary":"Load ApiKey","description":"Load your existing ApiKey info. Required Access Level: Security","operationId":"securityApikeysByNameGet","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which ApiKey should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}}},"put":{"tags":["Security"],"summary":"Update ApiKey","description":"Update your existing ApiKey. Required Access Level: Security","operationId":"securityApikeysByNamePut","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKey"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiKeyPayload"}}},"required":true}},"delete":{"tags":["Security"],"summary":"Delete ApiKey","description":"Delete your existing ApiKey. Required Access Level: Security","operationId":"securityApikeysByNameDelete","parameters":[{"name":"name","description":"Name of the ApiKey","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which ApiKey should be deleted","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/security/smtp":{"get":{"tags":["Security"],"summary":"List SMTP Credentials","description":"List all your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpGet","parameters":[{"name":"subaccount","description":"Email of the subaccount of which credentials should be listed","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SmtpCredentials"},"type":"array"}}}}}},"post":{"tags":["Security"],"summary":"Add SMTP Credential","description":"Add new SMTP Credential. Required Access Level: Security","operationId":"securitySmtpPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NewSmtpCredentials"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentialsPayload"}}},"required":true}}},"/security/smtp/{name}":{"get":{"tags":["Security"],"summary":"Load SMTP Credential","description":"Load your existing SMTP Credential info. Required Access Level: Security","operationId":"securitySmtpByNameGet","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which credential should be loaded","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentials"}}}}}},"put":{"tags":["Security"],"summary":"Update SMTP Credential","description":"Update your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpByNamePut","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentials"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SmtpCredentialsPayload"}}},"required":true}},"delete":{"tags":["Security"],"summary":"Delete SMTP Credential","description":"Delete your existing SMTP Credentials. Required Access Level: Security","operationId":"securitySmtpByNameDelete","parameters":[{"name":"name","description":"Name of the SMTP Credential","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"subaccount","description":"Email of the subaccount of which credential should be deleted","in":"query","required":false,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/segments":{"get":{"tags":["Segments"],"summary":"Load Segments","description":"Returns a list of all your available Segments. Required Access Level: ViewContacts","operationId":"segmentsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Segment"},"type":"array"}}}}}},"post":{"tags":["Segments"],"summary":"Add Segment","description":"Add a new segment, based on specified RULE. Required Access Level: ModifyContacts","operationId":"segmentsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentPayload"}}},"required":true}}},"/segments/{name}":{"get":{"tags":["Segments"],"summary":"Load Segment","description":"Returns details for the specified segment. Required Access Level: ViewContacts","operationId":"segmentsByNameGet","parameters":[{"name":"name","description":"Name of the segment you want to load. Will load all contacts if the 'All Contacts' name has been provided","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}}},"put":{"tags":["Segments"],"summary":"Update Segment","description":"Rename or change RULE for your segment. Required Access Level: ModifyContacts","operationId":"segmentsByNamePut","parameters":[{"name":"name","description":"Name of your segment.","in":"path","required":true,"schema":{"example":"My Segment 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Segment"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SegmentPayload"}}},"required":true}},"delete":{"tags":["Segments"],"summary":"Delete Segment","description":"Delete an existing segment. Required Access Level: ModifyContacts","operationId":"segmentsByNameDelete","parameters":[{"name":"name","description":"Name of your segment.","in":"path","required":true,"schema":{"example":"My Segment 1","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/statistics":{"get":{"tags":["Statistics"],"summary":"Load Statistics","description":"Returns basic statistics. Required Access Level: ViewReports","operationId":"statisticsGet","parameters":[{"name":"from","description":"Starting date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":true,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","type":"string","description":"string"}},{"name":"to","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format.","in":"query","required":false,"schema":{"example":"2001-01-01T01:01:01","format":"date-time","nullable":true,"type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LogStatusSummary"}}}}}}},"/statistics/campaigns":{"get":{"tags":["Statistics"],"summary":"Load Campaigns Stats","description":"Returns a list of your Campaigns' stats. Required Access Level: ViewChannels","operationId":"statisticsCampaignsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelLogStatusSummary"},"type":"array"}}}}}}},"/statistics/campaigns/{name}":{"get":{"tags":["Statistics"],"summary":"Load Campaign Stats","description":"Retrieve stats of an existing campaign. Required Access Level: ViewChannels","operationId":"statisticsCampaignsByNameGet","parameters":[{"name":"name","description":"The name of the campaign to get.","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelLogStatusSummary"}}}}}}},"/statistics/channels":{"get":{"tags":["Statistics"],"summary":"Load Channels Stats","description":"Returns a list of your Channels' stats. Required Access Level: ViewChannels","operationId":"statisticsChannelsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ChannelLogStatusSummary"},"type":"array"}}}}}}},"/statistics/channels/{name}":{"get":{"tags":["Statistics"],"summary":"Load Channel Stats","description":"Retrieve an existing channel stats. Required Access Level: ViewChannels","operationId":"statisticsChannelsByNameGet","parameters":[{"name":"name","description":"The name of the channel to get.","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChannelLogStatusSummary"}}}}}}},"/subaccounts":{"get":{"tags":["SubAccounts"],"summary":"Load SubAccounts","description":"Returns a list of all your SubAccounts. Required Access Level: ViewSubAccounts","operationId":"subaccountsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SubAccountInfo"},"type":"array"}}}}}},"post":{"tags":["SubAccounts"],"summary":"Add SubAccount","description":"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. Required Access Level: ModifySubAccounts","operationId":"subaccountsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubAccountInfo"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountPayload"}}},"required":true}}},"/subaccounts/{email}":{"get":{"tags":["SubAccounts"],"summary":"Load SubAccount","description":"Returns details for the specified SubAccount. Required Access Level: ViewSubAccounts","operationId":"subaccountsByEmailGet","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubAccountInfo"}}}}}},"delete":{"tags":["SubAccounts"],"summary":"Delete SubAccount","description":"Deletes specified SubAccount. An email will be sent to confirm this change. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailDelete","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/subaccounts/{email}/credits":{"patch":{"tags":["SubAccounts"],"summary":"Add, Subtract Email Credits","description":"Update email credits of a subaccount by the given amount. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailCreditsPatch","parameters":[{"name":"email","description":"Email address of Sub-Account","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailCreditsPayload"}}},"description":"Amount of email credits to add or subtract from the current SubAccount email credits pool (positive or negative value)","required":true}}},"/subaccounts/{email}/settings/email":{"put":{"tags":["SubAccounts"],"summary":"Update SubAccount Email Settings","description":"Update SubAccount email settings. Required Access Level: ModifySubAccounts","operationId":"subaccountsByEmailSettingsEmailPut","parameters":[{"name":"email","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailSettings"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubaccountEmailSettings"}}},"description":"Updated Email Settings","required":true}}},"/suppressions":{"get":{"tags":["Suppressions"],"summary":"Get Suppressions","description":"Retrieve your suppressions. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}}},"/suppressions/{email}":{"get":{"tags":["Suppressions"],"summary":"Get Suppression","description":"Retrieve your suppression. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsByEmailGet","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Suppression"}}}}}},"delete":{"tags":["Suppressions"],"summary":"Delete Suppression","description":"Delete Suppression. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsByEmailDelete","parameters":[{"name":"email","description":"Proper email address.","in":"path","required":true,"schema":{"example":"mail@example.com","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/suppressions/bounces":{"get":{"tags":["Suppressions"],"summary":"Get Bounce List","description":"Retrieve your list of bounced emails. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsBouncesGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Bounces","description":"Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsBouncesPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as bounces. Limited to 1000 per request","required":true}}},"/suppressions/bounces/import":{"post":{"tags":["Suppressions"],"summary":"Add Bounces Async","description":"Add Bounced. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsBouncesImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as bounces.","required":true}}},"/suppressions/complaints":{"get":{"tags":["Suppressions"],"summary":"Get Complaints List","description":"Retrieve your list of complaints. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsComplaintsGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Complaints","description":"Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsComplaintsPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as complaints. Limited to 1000 per request","required":true}}},"/suppressions/complaints/import":{"post":{"tags":["Suppressions"],"summary":"Add Complaints Async","description":"Add Complaints. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsComplaintsImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as complaints.","required":true}}},"/suppressions/unsubscribes":{"get":{"tags":["Suppressions"],"summary":"Get Unsubscribes List","description":"Retrieve your list of unsubscribes. Required Access Level: ViewContacts, ViewSuppressions","operationId":"suppressionsUnsubscribesGet","parameters":[{"name":"search","description":"Text fragment used for searching.","in":"query","required":false,"schema":{"example":"text","format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}}},"post":{"tags":["Suppressions"],"summary":"Add Unsubscribes","description":"Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsUnsubscribesPost","responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Suppression"},"type":"array"}}}}},"requestBody":{"content":{"application/json":{"schema":{"items":{"format":"string","type":"string"},"type":"array"}}},"description":"Emails to add as unsubscribes. Limited to 1000 per request","required":true}}},"/suppressions/unsubscribes/import":{"post":{"tags":["Suppressions"],"summary":"Add Unsubscribes Async","description":"Add Unsubscribes. Required Access Level: ModifyContacts, ModifySuppressions","operationId":"suppressionsUnsubscribesImportPost","responses":{"202":{"description":"Accepted"}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Emails to add as unsubscribes.","required":true}}},"/templates":{"get":{"tags":["Templates"],"summary":"Load Templates","description":"Returns a list of templates for the specified type. Required Access Level: ViewTemplates","operationId":"templatesGet","parameters":[{"name":"scopeType","description":"Return templates with specified scope only","in":"query","required":true,"schema":{"items":{"$ref":"#/components/schemas/TemplateScope"},"type":"array","description":"array"}},{"name":"templateTypes","description":"Return templates with specified type only","in":"query","required":false,"schema":{"items":{"$ref":"#/components/schemas/TemplateType"},"type":"array","description":"array"}},{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"500","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Template"},"type":"array"}}}}}},"post":{"tags":["Templates"],"summary":"Add Template","description":"Add a new Template. Required Access Level: ModifyTemplates","operationId":"templatesPost","responses":{"201":{"description":"Template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}},"required":true}}},"/templates/{name}":{"get":{"tags":["Templates"],"summary":"Load Template","description":"Load detailed information of the specified template. Required Access Level: ViewTemplates","operationId":"templatesByNameGet","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"Serialized template","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}}},"put":{"tags":["Templates"],"summary":"Update Template","description":"Update existing template, overwriting existing data. Required Access Level: ModifyTemplates","operationId":"templatesByNamePut","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Template"}}}}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TemplatePayload"}}},"required":true}},"delete":{"tags":["Templates"],"summary":"Delete Template","description":"Delete template with the specified name. Required Access Level: ModifyTemplates","operationId":"templatesByNameDelete","parameters":[{"name":"name","description":"Name of template.","in":"path","required":true,"schema":{"example":"Template01","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications":{"get":{"tags":["Verifications"],"summary":"Get Emails Verification Results","description":"Returns a results of all verified single emails. Required Access Level: VerifyEmails","operationId":"verificationsGet","parameters":[{"name":"limit","description":"Maximum number of returned items.","in":"query","required":false,"schema":{"default":"0","example":"100","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many items should be returned ahead.","in":"query","required":false,"schema":{"default":"0","example":"20","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EmailValidationResult"},"type":"array"}}}}}}},"/verifications/{email}":{"get":{"tags":["Verifications"],"summary":"Get Email Verification Result","description":"Returns a result of verified email. Required Access Level: VerifyEmails","operationId":"verificationsByEmailGet","parameters":[{"name":"email","description":"Email address to view verification result of","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidationResult"}}}}}},"post":{"tags":["Verifications"],"summary":"Verify Email","description":"Verify single email address and returns result of verification. Required Access Level: VerifyEmails","operationId":"verificationsByEmailPost","parameters":[{"name":"email","description":"Email address to verify","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmailValidationResult"}}}}}},"delete":{"tags":["Verifications"],"summary":"Delete Email Verification Result","description":"Delete a result with given email if exists. Required Access Level: VerifyEmails","operationId":"verificationsByEmailDelete","parameters":[{"name":"email","description":"Email address to verification","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files":{"post":{"tags":["Verifications"],"summary":"Upload File with Emails","description":"Uploads a CSV file with list of emails that can then be triggered for verification. An 'email' column is required. Required Access Level: VerifyEmails","operationId":"verificationsFilesPost","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationFileResult"}}}}},"requestBody":{"content":{"multipart/form-data":{"schema":{"format":"binary","properties":{"file":{"format":"binary","type":"string"}},"type":"object"}}},"description":"Uploaded file","required":true}}},"/verifications/files/{id}":{"delete":{"tags":["Verifications"],"summary":"Delete File Verification Result","description":"Delete Verification Results if they exist. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdDelete","parameters":[{"name":"id","description":"ID of the exported file","in":"path","required":true,"schema":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files/{id}/result":{"get":{"tags":["Verifications"],"summary":"Get Detailed File Verification Result","description":"Returns status and results (if verified) of file with given ID. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdResultGet","parameters":[{"name":"id","description":"ID of the Verification to display status of","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}},{"name":"limit","description":"Maximum number of returned email verification results","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}},{"name":"offset","description":"How many result items should be returned ahead","in":"query","required":false,"schema":{"default":"0","format":"int32","type":"integer","description":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerificationFileResultDetails"}}}}}}},"/verifications/files/{id}/result/download":{"get":{"tags":["Verifications"],"summary":"Download File Verification Result","description":"Download verification results as a ZIP file. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdResultDownloadGet","parameters":[{"name":"id","description":"Verification ID to download","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"A ZIP file with verification details","content":{"application/*":{"schema":{"format":"binary","type":"string"}}}}}}},"/verifications/files/{id}/verification":{"post":{"tags":["Verifications"],"summary":"Start verification","description":"Start a verification of the previously uploaded file with emails. Required Access Level: VerifyEmails","operationId":"verificationsFilesByIdVerificationPost","parameters":[{"name":"id","description":"File ID to start verification","in":"path","required":true,"schema":{"format":"string","type":"string","description":"string"}}],"responses":{"200":{"description":"OK"}}}},"/verifications/files/result":{"get":{"tags":["Verifications"],"summary":"Get Files Verification Results","description":"Returns a list of uploaded files, their statuses and results. Required Access Level: VerifyEmails","operationId":"verificationsFilesResultGet","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/VerificationFileResult"},"type":"array"}}}}}}}},"components":{"schemas":{"AccessLevel":{"default":"None","type":"string","enum":["None","ViewAccount","ViewContacts","ViewForms","ViewTemplates","ViewCampaigns","ViewChannels","ViewAutomations","ViewSurveys","ViewSettings","ViewBilling","ViewSubAccounts","ViewUsers","ViewFiles","ViewReports","ModifyAccount","ModifyContacts","ModifyForms","ModifyTemplates","ModifyCampaigns","ModifyChannels","ModifyAutomations","ModifySurveys","ModifyFiles","Export","SendSmtp","SendSMS","ModifySettings","ModifyBilling","ModifyProfile","ModifySubAccounts","ModifyUsers","Security","ModifyLanguage","ViewSupport","SendHttp","Modify2FAEmail","ModifySupport","ViewCustomFields","ModifyCustomFields","ModifyWebNotifications","ExtendedLogs","VerifyEmails","Modify2FASms","ModifyLandingPages","ViewLandingPages","ModifySuppressions","ViewSuppressions","ViewDragDropEditor","ViewTemplateEditor","ViewAITools","ModifySubscriptionAntiSpam"]},"AccountStatusEnum":{"default":"Disabled","type":"string","enum":["Disabled","UnderReview","NeverSignedIn","Active"]},"ApiKey":{"properties":{"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Name":{"format":"string","type":"string","description":"Name of the ApiKey."},"DateCreated":{"format":"date-time","type":"string","description":"Date this ApiKey was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"}},"type":"object","description":"ApiKey info"},"ApiKeyPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Name of the ApiKey for ease of reference."},"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"},"Subaccount":{"format":"string","type":"string","description":"Email of the subaccount for which this ApiKey should be created"}},"required":["Name","AccessLevel"],"type":"object","description":"Create a new ApiKey"},"BodyContentType":{"default":"HTML","type":"string","description":"Type of body part","enum":["HTML","PlainText","AMP","CSS"]},"BodyPart":{"properties":{"ContentType":{"$ref":"#/components/schemas/BodyContentType"},"Content":{"format":"string","type":"string","description":"Actual content of the body part"},"Charset":{"format":"string","type":"string","description":"Text value of charset encoding for example: iso-8859-1, windows-1251, utf-8, us-ascii, windows-1250 and more..."}},"required":["ContentType"],"type":"object","description":"Email body part with user-provided MIME type (text/html, text/plain, etc)"},"Campaign":{"properties":{"Content":{"items":{"$ref":"#/components/schemas/CampaignTemplate"},"type":"array","description":"Campaign's email content. Provide multiple items to send an A/X Split Campaign"},"Name":{"format":"string","type":"string","description":"Campaign name"},"Status":{"$ref":"#/components/schemas/CampaignStatus"},"Recipients":{"$ref":"#/components/schemas/CampaignRecipient"},"Options":{"$ref":"#/components/schemas/CampaignOptions"}},"required":["Name","Recipients"],"type":"object"},"CampaignOptions":{"properties":{"DeliveryOptimization":{"$ref":"#/components/schemas/DeliveryOptimizationType"},"TrackOpens":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used."},"TrackClicks":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used."},"ScheduleFor":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date when this Campaign is scheduled to be sent on"},"TriggerFrequency":{"format":"double","type":"number","description":"How often (in minutes) to send the campaign"},"TriggerCount":{"format":"int32","type":"integer","description":"How many times send the campaign"},"SplitOptions":{"$ref":"#/components/schemas/SplitOptions"}},"type":"object","description":"Different send options for a Campaign"},"CampaignRecipient":{"properties":{"ListNames":{"items":{"format":"string","type":"string"},"type":"array","description":"Names of lists from your Account to read recipients from"},"SegmentNames":{"items":{"format":"string","type":"string"},"type":"array","description":"Names of segments from your Account to read recipients from"}},"type":"object","description":"A set of lists and segments names to read recipients from"},"CampaignStatus":{"default":"Deleted","type":"string","enum":["Deleted","Active","Processing","Sending","Completed","Paused","Cancelled","Draft"]},"CampaignTemplate":{"properties":{"Poolname":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"From":{"example":"John Doe ","format":"string","type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )"},"ReplyTo":{"example":"John Doe ","format":"string","type":"string","description":"To what address should the recipients reply to (e.g. John Doe )"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"TemplateName":{"example":"Template01","format":"string","type":"string","description":"Name of template."},"AttachFiles":{"example":["preuploaded.jpg"],"items":{"format":"string","type":"string"},"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Utm":{"$ref":"#/components/schemas/Utm"}},"required":["From"],"type":"object","description":"Content of a Campaign"},"ChannelLogStatusSummary":{"properties":{"ChannelName":{"format":"string","type":"string","description":"Channel name"},"Recipients":{"example":"1234","format":"int64","type":"integer","description":"Number of recipients"},"EmailTotal":{"example":"1234","format":"int64","type":"integer","description":"Number of emails"},"SmsTotal":{"example":"12","format":"int64","type":"integer","description":"Number of SMS"},"Delivered":{"example":"1000","format":"int64","type":"integer","description":"Number of delivered messages"},"Bounced":{"example":"1000","format":"int64","type":"integer","description":"Number of bounced messages"},"InProgress":{"example":"1234","format":"int64","type":"integer","description":"Number of messages in progress"},"Opened":{"example":"1000","format":"int64","type":"integer","description":"Number of opened messages"},"Clicked":{"example":"1000","format":"int64","type":"integer","description":"Number of clicked messages"},"Unsubscribed":{"example":"1000","format":"int64","type":"integer","description":"Number of unsubscribed messages"},"Complaints":{"example":"1000","format":"int64","type":"integer","description":"Number of complaint messages"},"Inbound":{"example":"1000","format":"int64","type":"integer","description":"Number of inbound messages"},"ManualCancel":{"example":"1000","format":"int64","type":"integer","description":"Number of manually cancelled messages"},"NotDelivered":{"example":"0","format":"int64","type":"integer","description":"Number of messages flagged with 'Not Delivered'"}},"type":"object","description":"Summary of channel log status"},"CompressionFormat":{"default":"None","type":"string","description":"FileResponse compression format","enum":["None","Zip"]},"ConsentData":{"properties":{"ConsentIP":{"example":"192.168.0.1","format":"string","type":"string","description":"IP address of consent to send this contact(s) your email. If not provided your current public IP address is used for consent."},"ConsentDate":{"example":"1/1/2015 0:00:00 AM","format":"date-time","nullable":true,"type":"string","description":"Date of consent to send this contact(s) your email. If not provided current date is used for consent."},"ConsentTracking":{"$ref":"#/components/schemas/ConsentTracking"}},"type":"object"},"ConsentTracking":{"default":"Unknown","type":"string","enum":["Unknown","Allow","Deny"]},"Contact":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Status":{"$ref":"#/components/schemas/ContactStatus"},"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom contact fields which can be used in the system."},"Consent":{"$ref":"#/components/schemas/ConsentData"},"Source":{"$ref":"#/components/schemas/ContactSource"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"DateUpdated":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Last change date"},"StatusChangeDate":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date of last status change."},"Activity":{"$ref":"#/components/schemas/ContactActivity"}},"type":"object","description":"Contact"},"ContactActivity":{"properties":{"TotalSent":{"example":"1000","format":"int32","type":"integer","description":"Total emails sent."},"TotalOpened":{"example":"1000","format":"int32","type":"integer","description":"Total emails opened."},"TotalClicked":{"example":"1000","format":"int32","type":"integer","description":"Total emails clicked"},"TotalFailed":{"example":"1000","format":"int32","type":"integer","description":"Total emails failed."},"LastSent":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Last date when an email was sent to this contact"},"LastOpened":{"example":"2014-01-01","format":"date-time","nullable":true,"type":"string","description":"Date this contact last opened an email"},"LastClicked":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this contact last clicked an email"},"LastFailed":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Last date when an email sent to this contact bounced"},"LastIP":{"format":"string","type":"string","description":"IP from which this contact opened or clicked their email last time"},"ErrorCode":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"Last RFC Error code if any occurred"},"FriendlyErrorMessage":{"format":"string","type":"string","description":"Last RFC error message if any occurred"}},"type":"object"},"ContactPayload":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Status":{"$ref":"#/components/schemas/ContactStatus"},"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"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."},"Consent":{"$ref":"#/components/schemas/ConsentData"}},"required":["Email"],"type":"object"},"ContactSource":{"default":"DeliveryApi","type":"string","enum":["DeliveryApi","ManualInput","FileUpload","WebForm","ContactApi","VerificationApi","FileVerificationApi"]},"ContactStatus":{"default":"Transactional","type":"string","enum":["Transactional","Engaged","Active","Bounced","Unsubscribed","Abuse","Inactive","Stale","NotConfirmed"]},"ContactUpdatePayload":{"properties":{"FirstName":{"example":"Fred","format":"string","type":"string","description":"First name."},"LastName":{"example":"Flintstone","format":"string","type":"string","description":"Last name."},"CustomFields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom contact fields which can be used in the system."}},"type":"object"},"DeliveryOptimizationType":{"default":"None","type":"string","enum":["None","ToEngagedFirst","ByOpenTime"]},"EmailContent":{"properties":{"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"List of e-mail body parts, with user-provided MIME types (text/html, text/plain etc)"},"Merge":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"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."},"Attachments":{"items":{"$ref":"#/components/schemas/MessageAttachment"},"type":"array","description":"Attachments provided by sending binary data"},"Headers":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of custom e-mail headers."},"Postback":{"format":"string","type":"string","description":"Postback header."},"EnvelopeFrom":{"example":"John Doe ","format":"string","type":"string","description":"E-mail with an optional name to be used as the envelope from address (e.g.: John Doe )"},"From":{"example":"John Doe ","format":"string","type":"string","description":"Your e-mail with an optional name (e.g.: John Doe )"},"ReplyTo":{"example":"John Doe ","format":"string","type":"string","description":"To what address should the recipients reply to (e.g. John Doe )"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"TemplateName":{"example":"Template01","format":"string","type":"string","description":"Name of template."},"AttachFiles":{"example":["preuploaded.jpg"],"items":{"format":"string","type":"string"},"type":"array","description":"Names of previously uploaded files that should be sent as downloadable attachments"},"Utm":{"$ref":"#/components/schemas/Utm"}},"required":["From"],"type":"object","description":"Proper e-mail content"},"EmailData":{"properties":{"Preview":{"$ref":"#/components/schemas/EmailView"},"Attachments":{"items":{"$ref":"#/components/schemas/FileInfo"},"type":"array","description":"Attachments sent with the email"},"Status":{"$ref":"#/components/schemas/EmailStatus"}},"type":"object"},"EmailJobFailedStatus":{"properties":{"Address":{"format":"string","type":"string"},"Error":{"format":"string","type":"string"},"ErrorCode":{"example":"550","format":"int32","type":"integer","description":"RFC Error code"},"Category":{"format":"string","type":"string"}},"type":"object"},"EmailJobStatus":{"properties":{"ID":{"example":"123456","format":"string","type":"string","description":"ID number of your attachment"},"Status":{"format":"string","type":"string","description":"Name of status: submitted, complete, in_progress"},"RecipientsCount":{"format":"int32","type":"integer"},"Failed":{"items":{"$ref":"#/components/schemas/EmailJobFailedStatus"},"type":"array"},"FailedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails failed."},"Sent":{"items":{"format":"string","type":"string"},"type":"array"},"SentCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails sent."},"Delivered":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of delivered messages"},"DeliveredCount":{"format":"int32","type":"integer"},"Pending":{"items":{"format":"string","type":"string"},"type":"array"},"PendingCount":{"format":"int32","type":"integer"},"Opened":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of opened messages"},"OpenedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails opened."},"Clicked":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of clicked messages"},"ClickedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails clicked"},"Unsubscribed":{"example":["1000"],"items":{"format":"string","type":"string"},"type":"array","description":"Number of unsubscribed messages"},"UnsubscribedCount":{"example":"1000","format":"int32","type":"integer","description":"Total emails unsubscribed"},"AbuseReports":{"items":{"format":"string","type":"string"},"type":"array"},"AbuseReportsCount":{"format":"int32","type":"integer"},"MessageIDs":{"items":{"format":"string","type":"string"},"type":"array","description":"List of all MessageIDs for this job."}},"type":"object"},"EmailMessageData":{"properties":{"Recipients":{"items":{"$ref":"#/components/schemas/EmailRecipient"},"type":"array","description":"List of recipients"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["Recipients","Content"],"type":"object","description":"Email data"},"EmailPredictedValidationStatus":{"default":"None","type":"string","enum":["None","Valid","LowRisk","HighRisk","Invalid"]},"EmailRecipient":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Fields":{"example":{"city":"New York","age":"34"},"additionalProperties":{"type":"string"},"type":"object","description":"A key-value collection of merge fields which can be used in e-mail body."}},"required":["Email"],"type":"object","description":"List of recipients"},"EmailSend":{"properties":{"TransactionID":{"example":"TransactionID","format":"string","type":"string","description":"ID number of transaction"},"MessageID":{"example":"-HHGPM_9RPhSMiaJq_ab4g3","format":"string","type":"string","description":"Unique identifier for this email."}},"type":"object"},"EmailsPayload":{"properties":{"Rule":{"format":"string","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"},"Emails":{"example":["john.doe@sample.com"],"items":{"format":"string","type":"string"},"type":"array","description":"Comma delimited list of contact emails"}},"type":"object","description":"Provide either rule or a list of emails, not both."},"EmailStatus":{"properties":{"From":{"format":"string","type":"string","description":"Email address this email was sent from."},"To":{"format":"string","type":"string","description":"Email address this email was sent to."},"Date":{"format":"date-time","type":"string","description":"Date the email was submitted."},"Status":{"$ref":"#/components/schemas/LogJobStatus"},"StatusName":{"format":"string","type":"string","description":"Name of email's status"},"StatusChangeDate":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of last status change."},"DateSent":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date when the email was sent"},"DateOpened":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date when the email changed the status to 'opened'"},"DateClicked":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date when the email changed the status to 'clicked'"},"ErrorMessage":{"format":"string","type":"string","description":"Detailed error or bounced message."},"TransactionID":{"example":"TransactionID","format":"guid","type":"string","description":"ID number of transaction"},"EnvelopeFrom":{"format":"string","type":"string","description":"Envelope from address"}},"type":"object","description":"Status information of the specified email"},"EmailTransactionalMessageData":{"properties":{"Recipients":{"$ref":"#/components/schemas/TransactionalRecipient"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["Recipients","Content"],"type":"object","description":"Email data"},"EmailValidationResult":{"properties":{"Account":{"format":"string","type":"string","description":"Local part of an email"},"Domain":{"example":"example.com","format":"string","type":"string","description":"Name of selected domain."},"Email":{"format":"string","type":"string","description":"Full email address that was verified"},"SuggestedSpelling":{"format":"string","type":"string","description":"Suggested spelling if a possible mistake was found"},"Disposable":{"format":"boolean","type":"boolean","description":"Does the email have a temporary domain"},"Role":{"format":"boolean","type":"boolean","description":"Is an email a role email (e.g. info@, noreply@ etc.)"},"Reason":{"format":"string","type":"string","description":"All detected issues"},"DateAdded":{"format":"date-time","type":"string","description":"Added date"},"Result":{"$ref":"#/components/schemas/EmailValidationStatus"},"PredictedScore":{"format":"single","type":"number","description":"Predicted score"},"PredictedStatus":{"$ref":"#/components/schemas/EmailPredictedValidationStatus"}},"type":"object"},"EmailValidationStatus":{"default":"None","type":"string","enum":["None","Valid","Unknown","Risky","Invalid"]},"EmailView":{"properties":{"Body":{"format":"string","type":"string","description":"Body (HTML, otherwise plain text) of email"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"From":{"format":"string","type":"string","description":"From email address"}},"type":"object","description":"Email details formatted in json"},"EncodingType":{"default":"UserProvided","type":"string","description":"Encoding type for the email headers","enum":["UserProvided","None","Raw7bit","Raw8bit","QuotedPrintable","Base64","Uue"]},"EventsOrderBy":{"default":"DateDescending","type":"string","enum":["DateDescending","DateAscending"]},"EventType":{"default":"Submission","type":"string","description":"Type of event","enum":["Submission","FailedAttempt","Bounce","Sent","Open","Click","Unsubscribe","Complaint"]},"ExportFileFormats":{"default":"Csv","type":"string","description":"Format of the exported file.","enum":["Csv","Xml","Json"]},"ExportLink":{"properties":{"Link":{"format":"string","type":"string","description":"Direct URL to the exported file"},"PublicExportID":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","type":"string","description":"ID of the exported file"}},"type":"object"},"ExportStatus":{"default":"Error","type":"string","description":"Current status of the export.","enum":["Error","Loading","Ready","Expired"]},"FileInfo":{"properties":{"FileName":{"example":"filename.txt","format":"string","type":"string","description":"Name of your file including extension."},"Size":{"example":"100","format":"int32","nullable":true,"type":"integer","description":"Size of your attachment (in bytes)."},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"ExpirationDate":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date when the file will be deleted from your Account."},"ContentType":{"example":"image/jpeg","format":"string","type":"string","description":"Content type of the file."}},"type":"object","description":"File information"},"FilePayload":{"properties":{"BinaryContent":{"format":"byte","type":"string","description":"Content of the file sent as binary data"},"Name":{"example":"attachment.txt","format":"string","type":"string","description":"Filename"},"ContentType":{"format":"string","type":"string","description":"Type of file's content (e.g. image/jpeg)"}},"required":["BinaryContent"],"type":"object"},"FileUploadResult":{"properties":{"EmailsCount":{"format":"int32","type":"integer","description":"How many unique emails were detected the file"},"DuplicatedEmailsCount":{"format":"int32","type":"integer","description":"How many email duplicates were detected"}},"type":"object"},"InboundPayload":{"properties":{"Filter":{"format":"string","type":"string","description":"Filter of the inbound data"},"Name":{"format":"string","type":"string","description":"Name of this route"},"FilterType":{"$ref":"#/components/schemas/InboundRouteFilterType"},"ActionType":{"$ref":"#/components/schemas/InboundRouteActionType"},"EmailAddress":{"format":"string","type":"string","description":"Email to forward the inbound to"},"HttpAddress":{"format":"string","type":"string","description":"Address to notify about the inbound"}},"required":["Filter","Name","FilterType","ActionType"],"type":"object"},"InboundRoute":{"properties":{"PublicId":{"format":"string","type":"string"},"Name":{"format":"string","type":"string","description":"Name of this route"},"FilterType":{"$ref":"#/components/schemas/InboundRouteFilterType"},"Filter":{"format":"string","type":"string","description":"Filter of the inbound data"},"ActionType":{"$ref":"#/components/schemas/InboundRouteActionType"},"ActionParameter":{"format":"string","type":"string","description":"URL address or Email to notify about the inbound"},"SortOrder":{"format":"int32","type":"integer","description":"Place of this route in your routes queue's order"}},"type":"object"},"InboundRouteActionType":{"default":"ForwardToEmail","type":"string","enum":["ForwardToEmail","NotifyViaHttp","Stop"]},"InboundRouteFilterType":{"default":"EmailAddress","type":"string","enum":["EmailAddress","Subject"]},"ContactsList":{"properties":{"ListName":{"example":"My List 1","format":"string","type":"string","description":"Name of your list."},"PublicListID":{"example":"E33EBA7A-C20D-4D3D-8F2F-5EEF42F58E6F","format":"guid","nullable":true,"type":"string","description":"ID code of list. Please note that this is different from the listid field."},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"}},"type":"object","description":"List of Lists, with detailed data about its contents."},"ListPayload":{"properties":{"ListName":{"example":"My List 1","format":"string","type":"string","description":"Name of your list."},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"},"Emails":{"example":["john.doe@sample.com"],"items":{"format":"string","type":"string"},"type":"array","description":"Comma delimited list of existing contact emails that should be added to this list. Leave empty for all contacts"}},"required":["ListName"],"type":"object"},"ListUpdatePayload":{"properties":{"NewListName":{"example":"My List 2","format":"string","type":"string","description":"Name of your list if you want to change it."},"AllowUnsubscribe":{"example":"true/false","format":"boolean","type":"boolean","description":"True: Allow unsubscribing from this list. Otherwise, false"}},"type":"object"},"LogJobStatus":{"default":"All","type":"string","enum":["All","ReadyToSend","WaitingToRetry","Sending","Error","Sent","Opened","Clicked","Unsubscribed","AbuseReport"]},"LogStatusSummary":{"properties":{"Recipients":{"example":"1234","format":"int64","type":"integer","description":"Number of recipients"},"EmailTotal":{"example":"1234","format":"int64","type":"integer","description":"Number of emails"},"SmsTotal":{"example":"12","format":"int64","type":"integer","description":"Number of SMS"},"Delivered":{"example":"1000","format":"int64","type":"integer","description":"Number of delivered messages"},"Bounced":{"example":"1000","format":"int64","type":"integer","description":"Number of bounced messages"},"InProgress":{"example":"1234","format":"int64","type":"integer","description":"Number of messages in progress"},"Opened":{"example":"1000","format":"int64","type":"integer","description":"Number of opened messages"},"Clicked":{"example":"1000","format":"int64","type":"integer","description":"Number of clicked messages"},"Unsubscribed":{"example":"1000","format":"int64","type":"integer","description":"Number of unsubscribed messages"},"Complaints":{"example":"1000","format":"int64","type":"integer","description":"Number of complaint messages"},"Inbound":{"example":"1000","format":"int64","type":"integer","description":"Number of inbound messages"},"ManualCancel":{"example":"1000","format":"int64","type":"integer","description":"Number of manually cancelled messages"},"NotDelivered":{"example":"0","format":"int64","type":"integer","description":"Number of messages flagged with 'Not Delivered'"}},"type":"object","description":"Summary of log status"},"MergeEmailPayload":{"properties":{"MergeFile":{"$ref":"#/components/schemas/MessageAttachment"},"Content":{"$ref":"#/components/schemas/EmailContent"},"Options":{"$ref":"#/components/schemas/Options"}},"required":["MergeFile","Content"],"type":"object"},"MessageAttachment":{"properties":{"BinaryContent":{"format":"byte","type":"string","description":"File's content as byte array (or a Base64 string)"},"Name":{"format":"string","type":"string","description":"Display name of the file"},"ContentType":{"format":"string","type":"string","description":"MIME content type"},"Size":{"example":"100","format":"int32","type":"integer","description":"Size of your attachment (in bytes)."}},"required":["BinaryContent","Name"],"type":"object"},"MessageCategory":{"default":"Unknown","type":"string","enum":["Unknown","Ignore","Spam","BlackListed","NoMailbox","GreyListed","Throttled","Timeout","ConnectionProblem","SPFProblem","AccountProblem","DNSProblem","NotDeliveredCancelled","CodeError","ManualCancel","ConnectionTerminated","NotDelivered"]},"NewApiKey":{"properties":{"Token":{"format":"string","type":"string","description":"Unique token to be used in the system"},"AccessLevel":{"items":{"$ref":"#/components/schemas/AccessLevel"},"type":"array","description":"Access level or permission to be assigned to this ApiKey."},"Name":{"format":"string","type":"string","description":"Name of the ApiKey."},"DateCreated":{"format":"date-time","type":"string","description":"Date this ApiKey was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this ApiKey expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this ApiKey"}},"type":"object","description":"Newly generated ApiKey with Token"},"NewSmtpCredentials":{"properties":{"Token":{"format":"string","type":"string","description":"Unique token to be used in the system"},"AccessLevel":{"$ref":"#/components/schemas/AccessLevel"},"Name":{"format":"string","type":"string","description":"Name of the key."},"DateCreated":{"format":"date-time","type":"string","description":"Date this SmtpCredential was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"}},"type":"object","description":"Newly generated SMTP Credentials with Token"},"Options":{"properties":{"TimeOffset":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"By how long should an e-mail be delayed (in minutes). Maximum is 35 days."},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ChannelName":{"example":"Channel01","format":"string","type":"string","description":"Name of selected channel."},"Encoding":{"$ref":"#/components/schemas/EncodingType"},"TrackOpens":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the opens be tracked? If no value has been provided, Account's default setting will be used."},"TrackClicks":{"example":"true","format":"boolean","nullable":true,"type":"boolean","description":"Should the clicks be tracked? If no value has been provided, Account's default setting will be used."}},"type":"object","description":"E-mail configuration"},"RecipientEvent":{"properties":{"TransactionID":{"example":"TransactionID","format":"string","type":"string","description":"ID number of transaction"},"MsgID":{"example":"ABCDE_9RPhSWiaJq_ab1g1","format":"string","type":"string","description":"ID number of selected message."},"FromEmail":{"example":"sender@yourdomain.com","format":"string","type":"string","description":"Default From: email address."},"To":{"example":"2001-01-01T01:01:01","format":"string","type":"string","description":"Ending date for search in YYYY-MM-DDThh:mm:ss format."},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"EventType":{"$ref":"#/components/schemas/EventType"},"EventDate":{"format":"date-time","type":"string","description":"Creation date"},"ChannelName":{"example":"Channel01","format":"string","type":"string","description":"Name of selected channel."},"MessageCategory":{"$ref":"#/components/schemas/MessageCategory"},"NextTryOn":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Date of next try"},"Message":{"example":"Lorem ipsum","format":"string","type":"string","description":"Content of message, HTML encoded"},"IPAddress":{"format":"string","type":"string","description":"IP which this email was sent through"},"PoolName":{"format":"string","type":"string","description":"Name of an IP pool this email was sent through"}},"type":"object","description":"Detailed information about message recipient"},"Segment":{"properties":{"Name":{"format":"string","type":"string","description":"Segment name"},"Rule":{"format":"string","type":"string","description":"SQL-like rule to determine which Contacts belong to this Segment."}},"type":"object","description":"Dynamic collection of Contacts, managed by SQL-like rule."},"SegmentPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Segment name"},"Rule":{"format":"string","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":["Name","Rule"],"type":"object"},"SmtpCredentials":{"properties":{"AccessLevel":{"$ref":"#/components/schemas/AccessLevel"},"Name":{"format":"string","type":"string","description":"Name of the key."},"DateCreated":{"format":"date-time","type":"string","description":"Date this SmtpCredential was created."},"LastUse":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential was last used."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"}},"type":"object","description":"SMTP Credentials info"},"SmtpCredentialsPayload":{"properties":{"Name":{"format":"string","type":"string","description":"Name of the Credential for ease of reference. It must be a valid email address."},"Expires":{"example":null,"format":"date-time","nullable":true,"type":"string","description":"Date this SmtpCredential expires."},"RestrictAccessToIPRange":{"items":{"format":"string","type":"string"},"type":"array","description":"Which IPs can use this SmtpCredential"},"Subaccount":{"format":"string","type":"string","description":"Email of the subaccount for which this SmtpCredential should be created"}},"required":["Name"],"type":"object","description":"Create new SMTP Credentials"},"SortOrderItem":{"properties":{"PublicInboundId":{"format":"guid","type":"string","description":"ID of the route to change the order of"},"SortOrder":{"format":"int32","type":"integer","description":"1 - route will be used first"}},"required":["PublicInboundId","SortOrder"],"type":"object","description":"Change the ordering of this inbound route for when matching the inbound"},"SplitOptimizationType":{"default":"Opens","type":"string","enum":["Opens","Clicks"]},"SplitOptions":{"properties":{"OptimizeFor":{"$ref":"#/components/schemas/SplitOptimizationType"},"OptimizePeriodMinutes":{"example":"30","format":"int32","type":"integer","description":"For how long should the results be measured until determining the winner template (content)"}},"type":"object","description":"Optional A/X split campaign options"},"SubaccountEmailCreditsPayload":{"properties":{"Credits":{"format":"int32","type":"integer","description":"Positive or negative value; this will be added or subtracted from Subaccount's current email Credits pool."},"Notes":{"format":"string","type":"string","description":"Note to append to this credits change, for history."}},"required":["Credits"],"type":"object","description":"A change to SubAccount email credits pool, with an additional note."},"SubaccountEmailSettings":{"properties":{"MonthlyRefillCredits":{"example":"1000","format":"int32","type":"integer","description":"Amount of credits added to Account automatically"},"RequiresEmailCredits":{"example":"true","format":"boolean","type":"boolean","description":"True, if Account needs credits to send emails. Otherwise, false"},"EmailSizeLimit":{"example":"10","format":"int32","type":"integer","description":"Maximum size of email including attachments in MB's"},"DailySendLimit":{"example":"100000","format":"int32","type":"integer","description":"Amount of emails Account can send daily"},"MaxContacts":{"format":"int32","type":"integer","description":"Maximum number of contacts the Account can have. 0 means that parent account's limit is used."},"EnablePrivateIPPurchase":{"format":"boolean","type":"boolean","description":"Can the SubAccount purchase Private IP for themselves"},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ValidSenderDomainOnly":{"example":null,"format":"boolean","nullable":true,"type":"boolean"}},"type":"object","description":"Settings related to sending emails"},"SubaccountEmailSettingsPayload":{"properties":{"RequiresEmailCredits":{"example":"true","format":"boolean","type":"boolean","description":"True, if Account needs credits to send emails. Otherwise, false"},"EmailSizeLimit":{"example":"10","format":"int32","type":"integer","description":"Maximum size of email including attachments in MB's"},"DailySendLimit":{"example":"100000","format":"int32","type":"integer","description":"Amount of emails Account can send daily"},"MaxContacts":{"format":"int32","type":"integer","description":"Maximum number of contacts the Account can have. 0 means that parent account's limit is used."},"EnablePrivateIPPurchase":{"format":"boolean","type":"boolean","description":"Can the SubAccount purchase Private IP for themselves"},"PoolName":{"example":"My Custom Pool","format":"string","type":"string","description":"Name of your custom IP Pool to be used in the sending process"},"ValidSenderDomainOnly":{"example":null,"format":"boolean","nullable":true,"type":"boolean"}},"type":"object","description":"Settings related to sending emails"},"SubAccountInfo":{"properties":{"PublicAccountID":{"example":"EB3EBB7A-C20D-4D39-8F2F-5E6842F58E6F","format":"string","type":"string","description":"Public key for limited access to your Account such as contact/add so you can use it safely on public websites."},"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Settings":{"$ref":"#/components/schemas/SubaccountSettingsInfo"},"LastActivity":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of last activity on Account"},"EmailCredits":{"example":"1000","format":"int32","type":"integer","description":"Amount of email credits"},"TotalEmailsSent":{"example":"1000","format":"int64","type":"integer","description":"Amount of emails sent from this Account"},"Reputation":{"example":"100","format":"double","type":"number","description":"Numeric reputation"},"Status":{"$ref":"#/components/schemas/AccountStatusEnum"},"ContactsCount":{"format":"int32","type":"integer","description":"How many contacts this SubAccount has stored"}},"type":"object","description":"Detailed information about SubAccount."},"SubaccountPayload":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"Password":{"example":"********","format":"string","type":"string","description":"Current password."},"SendActivation":{"format":"boolean","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)."},"Settings":{"$ref":"#/components/schemas/SubaccountSettingsInfoPayload"}},"required":["Email","Password"],"type":"object","description":"New SubAccount payload"},"SubaccountSettingsInfo":{"properties":{"Email":{"$ref":"#/components/schemas/SubaccountEmailSettings"}},"type":"object","description":"SubAccount settings"},"SubaccountSettingsInfoPayload":{"properties":{"Email":{"$ref":"#/components/schemas/SubaccountEmailSettingsPayload"}},"type":"object","description":"SubAccount settings"},"Suppression":{"properties":{"Email":{"example":"mail@example.com","format":"string","type":"string","description":"Proper email address."},"FriendlyErrorMessage":{"example":"Mailbox not found","format":"string","type":"string","description":"RFC error message"},"ErrorCode":{"example":null,"format":"int32","nullable":true,"type":"integer","description":"SMTP Error code"},"DateUpdated":{"example":"2001-01-01T12:00:00","format":"date-time","nullable":true,"type":"string","description":"Last change date"}},"type":"object","description":"Suppression - Email returning Hard Bounces"},"Template":{"properties":{"TemplateType":{"$ref":"#/components/schemas/TemplateType"},"Name":{"format":"string","type":"string","description":"Template name"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"Email content of this template"},"TemplateScope":{"$ref":"#/components/schemas/TemplateScope"}},"type":"object","description":"Template info"},"TemplatePayload":{"properties":{"Name":{"format":"string","type":"string","description":"Template name"},"Subject":{"example":"Hello!","format":"string","type":"string","description":"Default subject of email."},"Body":{"items":{"$ref":"#/components/schemas/BodyPart"},"type":"array","description":"Email content of this template"},"TemplateScope":{"$ref":"#/components/schemas/TemplateScope"}},"required":["Name"],"type":"object","description":"New template object"},"TemplateScope":{"default":"Personal","type":"string","description":"Visibility of a template","enum":["Personal","Global"]},"TemplateType":{"default":"RawHTML","type":"string","enum":["RawHTML","DragDropEditor","LandingPageEditor","TemplateEditor","FormTemplate","LandingPageTemplate"]},"TransactionalRecipient":{"properties":{"To":{"items":{"format":"string","type":"string"},"type":"array","description":"List of recipients (visible to others)"},"CC":{"items":{"format":"string","type":"string"},"type":"array","description":"List of Carbon Copy recipients (visible to others)"},"BCC":{"items":{"format":"string","type":"string"},"type":"array","description":"List of Blind Carbon Copy recipients (hidden from other recipients)"}},"required":["To"],"type":"object","description":"List of transactional recipients"},"Utm":{"properties":{"Source":{"format":"string","type":"string","description":"utmsource value"},"Medium":{"format":"string","type":"string","description":"utmmedium value"},"Campaign":{"format":"string","type":"string","description":"utmcampaign value"},"Content":{"format":"string","type":"string","description":"utmcontent value"}},"type":"object","description":"Utm marketing data to be attached to every link in this e-mail."},"VerificationFileResult":{"properties":{"VerificationID":{"format":"string","type":"string","description":"Identifier of this verification result"},"Filename":{"format":"string","type":"string","description":"Origin file name"},"VerificationStatus":{"$ref":"#/components/schemas/VerificationStatus"},"FileUploadResult":{"$ref":"#/components/schemas/FileUploadResult"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Source":{"format":"string","type":"string","description":"Origin file extension"}},"type":"object","description":"Simple verification file result info"},"VerificationFileResultDetails":{"properties":{"VerificationResult":{"items":{"$ref":"#/components/schemas/EmailValidationResult"},"type":"array","description":"Verification result's details"},"VerificationID":{"format":"string","type":"string","description":"Identifier of this verification result"},"Filename":{"format":"string","type":"string","description":"Origin file name"},"VerificationStatus":{"$ref":"#/components/schemas/VerificationStatus"},"FileUploadResult":{"$ref":"#/components/schemas/FileUploadResult"},"DateAdded":{"example":"2001-01-01T12:00:00","format":"date-time","type":"string","description":"Date of creation in YYYY-MM-DDThh:ii:ss format"},"Source":{"format":"string","type":"string","description":"Origin file extension"}},"type":"object","description":"Detailed verification file result info"},"VerificationStatus":{"default":"Processing","type":"string","enum":["Processing","Ready","Expired","Verified","Error"]}},"securitySchemes":{"apikey":{"name":"X-ElasticEmail-ApiKey","in":"header","type":"apiKey"}}},"security":[{"apikey":[]}]}