{"_id":"57becfc8a08fa20e001eaa90","githubsync":"","parentDoc":null,"user":"55dd9841cafe7221002a4c62","__v":1,"category":{"_id":"55ddb5fa9067202b00ddff6f","project":"55dd9f2e0efd5821000d54d9","version":"55dd9f4dab0e4d210045aae9","__v":34,"pages":["55ddb83b9067202b00ddff71","55ddbc1e746ace2b00dd6f36","55ddc043bfd5072d002e7afe","55ddc38bbfd5072d002e7b04","55ddc96b9067202b00ddff90","55ddcd51746ace2b00dd6f4f","55ddd0cdbfd5072d002e7b1b","55deede1ddfb40170061ceba","55def281af76b70d0060a504","55def82cddfb40170061ced3","55defd7fa3d9010d0004190a","55df006286ae7f0d00db4bed","55df0149af76b70d0060a519","55df0231a3d9010d00041914","55df0b2086ae7f0d00db4c25","55df130faf76b70d0060a543","55df13dbaf76b70d0060a545","55df146f86ae7f0d00db4c3d","55df14d41f5cda170065be7c","55df16fcddfb40170061cf21","55df1917af76b70d0060a552","55df1a9c86ae7f0d00db4c53","55df1e25ddfb40170061cf2e","55df1f43af76b70d0060a565","55df204286ae7f0d00db4c61","55df21c3ddfb40170061cf34","55df22cfddfb40170061cf35","55df2461ddfb40170061cf38","55df287d1f5cda170065bea5","55df294dddfb40170061cf4f","55df2d57af76b70d0060a594","55df2def1f5cda170065bebf","55e046eaa44fae0d0021466f","55e0602558c5460d0076a9dc"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-08-26T12:50:02.812Z","from_sync":false,"order":3,"slug":"rest","title":"REST"},"project":"55dd9f2e0efd5821000d54d9","version":{"_id":"55dd9f4dab0e4d210045aae9","__v":47,"project":"55dd9f2e0efd5821000d54d9","createdAt":"2015-08-26T11:13:17.024Z","releaseDate":"2015-08-26T11:13:17.024Z","categories":["55dd9f4dab0e4d210045aaea","55ddb5fa9067202b00ddff6f","55e0472c6bad670d0081f213","55e04764a44fae0d00214671","55e047a9a44fae0d00214672","55e047b258c5460d0076a9a7","55e95e337fc27b2d00d32cf2","55e979bda7ca823900ad549a","55edb8c18dcb210d0056900b","55f0365c8563861700a33765","55f03677d58f9b1900acf996","55f036938eeefc23001ea5de","55f036a38563861700a33767","55f036c08563861700a33769","55f036d02911b72100482cd7","55f036e92911b72100482cd9","55f036fa8563861700a3376b","55f0370ee507711900e58c69","55f0371df6101b1900c70700","55f0374f2911b72100482cdb","55f0375e2911b72100482cdc","560eb0f659cb8d0d0015cd52","560eb25239fad419002ae1e0","561fb64d4d67490d00804b2a","562b9f775a39cd0d009aff22","562ba0505a39cd0d009aff23","562ba149d56bc30d00f0cb18","562ba595f68a5f0d007b1f3b","562ba78fd56bc30d00f0cb1b","562ba8b95a39cd0d009aff27","562baadf6562140d001501d2","562bab37f68a5f0d007b1f3d","562bc1bf9ebc950d000f7523","562bc99ced4bea0d00c11dfa","562bd29c1b98640d00714520","562bd5875a39cd0d009aff60","562bdfabff2da50d002c0aaf","562be0bd5a39cd0d009aff75","57a0b476d8313e1900454439","5b19051beece890003020163","5b34ded01cb20f000391ad6d","5b3a325acffe770003fd29e5","5b3c737a7f7b890003365501","5b3c929b367036000391b11e","5b7c1e210dc2e20003871521","5da48fa678007c00d3826dfd","5da4905f535c4a002716833a"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-08-25T11:00:24.610Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":1,"body":"All of our API's REST operations are listed below. Quickly scan for the method you're looking for and go straight to the documentation for it.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Operation\",\n    \"h-1\": \"Description\",\n    \"h-2\": \"Page link\",\n    \"0-0\": \"[Get account information](doc:get-account-information)\",\n    \"0-1\": \"Gets a summary of information about the current status of the account\",\n    \"0-2\": \"https://developer.dotmailer.com/docs/get-account-information\",\n    \"2-0\": \"[Create address book](doc:create-address-book)\",\n    \"2-1\": \"Creates an address book\",\n    \"2-2\": \"https://developer.dotmailer.com/docs/create-address-book\",\n    \"3-0\": \"[Delete address book](doc:delete-address-book)\",\n    \"3-1\": \"Deletes an address book by ID\",\n    \"3-2\": \"https://developer.dotmailer.com/docs/delete-address-book\",\n    \"4-0\": \"[Update address book](doc:update-address-book)\",\n    \"4-1\": \"Updates an address book by ID\",\n    \"4-2\": \"https://developer.dotmailer.com/docs/update-address-book\",\n    \"5-1\": \"Gets an address book by ID\",\n    \"5-2\": \"https://developer.dotmailer.com/docs/get-address-book\",\n    \"5-0\": \"[Gets an address book by ID](doc:get-address-book)\",\n    \"6-0\": \"[Get address books](doc:get-address-books)\",\n    \"6-1\": \"Gets all address books\",\n    \"6-2\": \"https://developer.dotmailer.com/docs/get-address-books\",\n    \"7-2\": \"https://developer.dotmailer.com/docs/get-private-address-books\",\n    \"7-1\": \"Gets all private address books\",\n    \"7-0\": \"[Get private address books](doc:get-private-address-books)\",\n    \"8-0\": \"[Get public address books](doc:get-public-address-books)\",\n    \"8-1\": \"Gets all public address books\",\n    \"8-2\": \"https://developer.dotmailer.com/docs/get-public-address-books\",\n    \"9-0\": \"[Create campaign](doc:create-campaign)\",\n    \"10-0\": \"[Update campaign](doc:update-campaign)\",\n    \"11-0\": \"[Copy campaign](doc:copy-campaign)\",\n    \"12-0\": \"[Delete campaign](doc:delete-campaign)\",\n    \"13-0\": \"[Send campaign](doc:send-campaign)\",\n    \"14-0\": \"[Send time optimised campaign](doc:send-time-optimised-campaign)\",\n    \"15-0\": \"[Get campaign send status](doc:get-campaign-send-status)\",\n    \"16-0\": \"[Add campaign attachment](doc:add-campaign-attachment)\",\n    \"17-0\": \"[Remove campaign attachment](doc:remove-campaign-attachment)\",\n    \"18-0\": \"[Get campaign attachments](doc:get-campaign-attachments)\",\n    \"19-0\": \"[Get all campaigns](doc:get-all-campaigns)\",\n    \"20-0\": \"[Get campaigns sent to address book or segment](doc:get-campaigns-sent-to-address-book-or-segment)\",\n    \"21-0\": \"[Get campaign](doc:get-campaign)\",\n    \"22-0\": \"[Get campaign summary](doc:get-campaign-summary)\",\n    \"23-0\": \"[Get campaign opens](doc:get-campaign-opens)\",\n    \"24-0\": \"[Get campaign opens for a contact](doc:get-campaign-opens-for-a-contact)\",\n    \"25-0\": \"[Get campaign activity for a contact](doc:get-campaign-activity-for-a-contact)\",\n    \"26-0\": \"[Get campaign activity since date](doc:get-campaign-activity-since-date)\",\n    \"27-0\": \"[Get campaign clicks](doc:get-campaign-clicks)\",\n    \"28-0\": \"[Get campaign clicks since date](doc:get-campaign-clicks-since-date)\",\n    \"29-0\": \"[Get campaign opens since date](doc:get-campaign-opens-since-date)\",\n    \"30-0\": \"[Get campaign activity](doc:get-campaign-activity)\",\n    \"31-0\": \"[Get campaign address books](doc:get-campaign-address-books)\",\n    \"32-0\": \"[Get campaign clicks for a contact](doc:get-campaign-clicks-for-a-contact)\",\n    \"33-0\": \"[Get campaigns with activity since date](doc:get-campaigns-with-activity-since-date)\",\n    \"34-0\": \"[Get campaign page views for a contact](doc:get-campaign-page-views-for-a-contact)\",\n    \"35-0\": \"[Get campaign page views since date](doc:get-campaign-page-views-since-date)\",\n    \"36-0\": \"[Get campaign replies for a contact](doc:get-campaign-replies-for-a-contact)\",\n    \"37-0\": \"[Get campaign ROI activity for a contact](doc:get-campaign-roi-activity-for-a-contact)\",\n    \"38-0\": \"[Get campaign ROI activity since date](doc:get-campaign-roi-activity-since-date)\",\n    \"39-0\": \"[Get campaign social bookmark views](doc:get-campaign-social-bookmark-views)\",\n    \"40-0\": \"[Get campaign social bookmark views for a contact](doc:get-campaign-social-bookmark-views-for-a-contact)\",\n    \"41-0\": \"[Get campaign hard bouncers](doc:get-campaign-hard-bouncers)\",\n    \"42-0\": \"[Create contact](doc:create-contact)\",\n    \"45-0\": \"[Delete contact](doc:delete-contact)\",\n    \"46-0\": \"[Update contact](doc:update-contact)\",\n    \"49-0\": \"[Add contact to address book](doc:add-contact-to-address-book)\",\n    \"50-0\": \"[Delete contact from address book](doc:delete-contact-from-address-book)\",\n    \"51-0\": \"[Delete contacts from address book](doc:delete-contacts-from-address-book)\",\n    \"52-0\": \"[Delete all contacts from address book](doc:delete-all-contacts-from-address-book)\",\n    \"53-0\": \"[Get contact by email](doc:get-contact-by-email)\",\n    \"54-0\": \"[Get contact by ID](doc:get-contact-by-id)\",\n    \"56-0\": \"[Get contact address books](doc:get-contact-address-books)\",\n    \"57-0\": \"[Get contacts](doc:get-contacts)\",\n    \"58-0\": \"[Get contacts created since date](doc:get-contacts-created-since-date)\",\n    \"59-0\": \"[Bulk create contacts](doc:bulk-create-contacts)\",\n    \"60-0\": \"[Bulk create contacts in address book](doc:bulk-create-contacts-in-address-book)\",\n    \"61-0\": \"[Get contact import status](doc:get-contact-import-status)\",\n    \"62-0\": \"[Get contact import report](doc:get-contact-import-report)\",\n    \"63-0\": \"[Get contact import report faults](doc:get-contact-import-report-faults)\",\n    \"64-0\": \"[Get contacts from address book](doc:get-contacts-from-address-book)\",\n    \"65-0\": \"[Get modified contacts in address book since date](doc:get-modified-contacts-in-address-book-since-date)\",\n    \"66-0\": \"[Get modified contacts since date](doc:get-modified-contacts-since-date)\",\n    \"67-0\": \"[Get suppressed contacts since date](doc:get-suppressed-contacts-since-date)\",\n    \"68-0\": \"[Get unsubscribed contacts since date](doc:get-unsubscribed-contacts-since-date)\",\n    \"69-0\": \"[Get unsubscribed contacts from address book since date](doc:get-unsubscribed-contacts-from-address-book-since-date)\",\n    \"70-0\": \"[Unsubscribe contact](doc:unsubscribe-contact)\",\n    \"71-0\": \"[Unsubscribe contact from address book](doc:unsubscribe-contact-from-address-book)\",\n    \"72-0\": \"[Resubscribe contact](doc:resubscribe-contact)\",\n    \"74-0\": \"[Resubscribe contact to address book](doc:resubscribe-contact-to-address-book)\",\n    \"76-0\": \"[Get scoring for contacts](doc:get-scoring-for-contacts)\",\n    \"77-0\": \"[Get scoring for contacts in address book](doc:get-scoring-for-contacts-in-address-book)\",\n    \"78-0\": \"[Get scoring modified since date for contacts](doc:get-scoring-modified-since-date-for-contacts)\",\n    \"79-0\": \"[Get scoring for contact by email](doc:get-scoring-for-contact-by-email)\",\n    \"80-0\": \"[Get scoring for contact by ID](doc:get-scoring-for-contact-by-id)\",\n    \"87-0\": \"[Create contact data field](doc:create-contact-data-field)\",\n    \"88-0\": \"[Delete contact data field](doc:delete-contact-data-field)\",\n    \"89-0\": \"[Get contact data fields](doc:get-contact-data-fields)\",\n    \"90-0\": \"[Get custom from addresses](doc:get-custom-from-addresses)\",\n    \"91-0\": \"[Create document folder](doc:create-document-folder)\",\n    \"92-0\": \"[Get document folders](doc:get-document-folders)\",\n    \"93-0\": \"[Get documents in folder](doc:get-documents-in-folder)\",\n    \"94-0\": \"[Upload document](doc:upload-document)\",\n    \"95-0\": \"[Create image folder](doc:create-image-folder)\",\n    \"96-0\": \"[Get image folders](doc:get-image-folders)\",\n    \"97-0\": \"[Get image folder by ID](doc:get-image-folder-by-id)\",\n    \"98-0\": \"[Upload campaign image](doc:upload-campaign-image)\",\n    \"106-0\": \"[Get programs](doc:get-programs)\",\n    \"107-0\": \"[Get program by ID](doc:get-program-by-id)\",\n    \"108-0\": \"[Create program enrolment](doc:create-program-enrolment)\",\n    \"109-0\": \"[Get program enrolment report faults](doc:get-program-enrolment-report-faults)\",\n    \"110-0\": \"[Get program enrolment](doc:get-program-enrolment)\",\n    \"111-0\": \"[Get program enrolments by status](doc:get-program-enrolment-by-status)\",\n    \"112-0\": \"[Get segments](doc:get-segments)\",\n    \"113-0\": \"[Refresh segment](doc:refresh-segment)\",\n    \"114-0\": \"[Get refresh progress for segment](doc:get-refresh-progress-for-segment)\",\n    \"115-0\": \"[Get server time](doc:get-server-time)\",\n    \"116-0\": \"[Send SMS message](doc:send-sms-message)\",\n    \"117-0\": \"[Get surveys](doc:get-surveys)\",\n    \"118-0\": \"[Get survey by ID](doc:get-survey-by-id)\",\n    \"119-0\": \"[Get survey fields](doc:get-survey-fields)\",\n    \"120-0\": \"[Get survey responses](doc:get-survey-responses)\",\n    \"121-0\": \"[Get survey responses with activity since date](doc:get-survey-responses-with-activity-since-date)\",\n    \"122-0\": \"[Get surveys with activity since date](doc:get-surveys-with-activity-since-date)\",\n    \"123-0\": \"[Create template](doc:create-template)\",\n    \"124-0\": \"[Get template by ID](doc:get-template-by-id)\",\n    \"125-0\": \"[Get templates](doc:get-templates)\",\n    \"126-0\": \"[Update template](doc:update-template)\",\n    \"127-0\": \"[Add transactional data to contact](doc:add-transactional-data-to-contact)\",\n    \"128-0\": \"[Bulk add transactional data to contacts](doc:bulk-add-transactional-data-to-contacts)\",\n    \"129-0\": \"[Get transactional data import status](doc:get-transactional-data-import-status)\",\n    \"130-0\": \"[Get transactional data import report](doc:get-transactional-data-import-report)\",\n    \"131-0\": \"[Delete transactional data collection for contact by email](doc:delete-transactional-data-collection-for-contact-by-email)\",\n    \"132-0\": \"[Get transactional data collection for contact by email](doc:get-transactional-data-collection-for-contact-by-email)\",\n    \"133-0\": \"[Delete transactional data collection for contact by ID](doc:delete-transactional-data-collection-for-contact-by-id)\",\n    \"134-0\": \"[Replace transactional data by key](doc:replace-transactional-data-by-key)\",\n    \"135-0\": \"[Delete transactional data by key](doc:delete-transactional-data-by-key)\",\n    \"136-0\": \"[Get transactional data by key](doc:get-transactional-data-by-key)\",\n    \"138-0\": \"[Send transactional email](doc:send-transactional-email)\",\n    \"140-0\": \"[Get transactional email statistics](doc:get-transactional-email-statistics)\",\n    \"9-1\": \"Creates a campaign\",\n    \"9-2\": \"https://developer.dotmailer.com/docs/create-campaign\",\n    \"10-2\": \"https://developer.dotmailer.com/docs/update-campaign\",\n    \"10-1\": \"Updates a given campaign\",\n    \"11-1\": \"Copies a given campaign, returning the new campaign\",\n    \"11-2\": \"https://developer.dotmailer.com/docs/copy-campaign\",\n    \"12-1\": \"Deletes a campaign\",\n    \"12-2\": \"https://developer.dotmailer.com/docs/delete-campaign\",\n    \"13-1\": \"Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send\",\n    \"13-2\": \"https://developer.dotmailer.com/docs/send-campaign\",\n    \"14-1\": \"Sends a specified campaign to one or more address books, segments or contacts at the most appropriate time based upon their previous opens\",\n    \"14-2\": \"https://developer.dotmailer.com/docs/send-time-optimised-campaign\",\n    \"15-1\": \"Gets a campaign send status using send ID\",\n    \"15-2\": \"https://developer.dotmailer.com/docs/get-campaign-send-status\",\n    \"16-1\": \"Adds a document to a campaign as an attachment\",\n    \"16-2\": \"https://developer.dotmailer.com/docs/add-campaign-attachment\",\n    \"17-1\": \"Removes an attachment from a campaign\",\n    \"17-2\": \"https://developer.dotmailer.com/docs/remove-campaign-attachment\",\n    \"18-2\": \"https://developer.dotmailer.com/docs/get-campaign-attachments\",\n    \"18-1\": \"Gets documents that are currently attached to a campaign\",\n    \"19-1\": \"Gets all campaigns\",\n    \"19-2\": \"https://developer.dotmailer.com/docs/get-all-campaigns\",\n    \"20-2\": \"https://developer.dotmailer.com/docs/get-campaigns-sent-to-address-book-or-segment\",\n    \"20-1\": \"Gets any campaigns that have been sent to an address book or a segment\",\n    \"21-1\": \"Gets a campaign by ID\",\n    \"21-2\": \"https://developer.dotmailer.com/docs/get-campaign\",\n    \"22-1\": \"Gets a summary of reporting information for a specified campaign\",\n    \"22-2\": \"https://developer.dotmailer.com/docs/get-campaign-summary\",\n    \"23-2\": \"https://developer.dotmailer.com/docs/get-campaign-opens\",\n    \"23-1\": \"Gets a list of campaign opens\",\n    \"24-1\": \"Gets a list of campaign opens for a contact\",\n    \"24-2\": \"https://developer.dotmailer.com/docs/get-campaign-opens-for-a-contact\",\n    \"25-1\": \"Gets activity for a given contact and given campaign\",\n    \"25-2\": \"https://developer.dotmailer.com/docs/get-campaign-activity-for-a-contact\",\n    \"26-1\": \"Gets a list of contacts who were sent a campaign, and retrieves only those contacts who showed activity (e.g. they clicked, opened) after a specified date\",\n    \"26-2\": \"https://developer.dotmailer.com/docs/get-campaign-activity-since-date\",\n    \"27-1\": \"Gets a list of campaign link clicks\",\n    \"27-2\": \"https://developer.dotmailer.com/docs/get-campaign-clicks\",\n    \"28-1\": \"Gets a list of link clicks for a campaign after a specified date\",\n    \"28-2\": \"https://developer.dotmailer.com/docs/get-campaign-clicks-since-date\",\n    \"29-1\": \"Gets a list of opens for a campaign after a specified date\",\n    \"29-2\": \"https://developer.dotmailer.com/docs/get-campaign-opens-since-date\",\n    \"30-2\": \"https://developer.dotmailer.com/docs/get-campaign-activity\",\n    \"30-1\": \"Gets a list of contacts who were sent a campaign, with their activity\",\n    \"31-1\": \"Gets any address books and segments that a campaign has ever been sent to\",\n    \"31-2\": \"https://developer.dotmailer.com/docs/get-campaign-address-books\",\n    \"32-1\": \"Gets a list of campaign link clicks for a contact\",\n    \"32-2\": \"https://developer.dotmailer.com/docs/get-campaign-clicks-for-a-contact\",\n    \"33-1\": \"Gets all sent campaigns, which have had activity (e.g. clicks, opens) after a specified date\",\n    \"33-2\": \"https://developer.dotmailer.com/docs/get-campaigns-with-activity-since-date\",\n    \"34-1\": \"Gets a list of page views for a specific campaign for a contact\",\n    \"34-2\": \"https://developer.dotmailer.com/docs/get-campaign-page-views-for-a-contact\",\n    \"35-1\": \"Gets a list of page views for a campaign after a specified date\",\n    \"35-2\": \"https://developer.dotmailer.com/docs/get-campaign-page-views-since-date\",\n    \"36-2\": \"https://developer.dotmailer.com/docs/get-campaign-replies-for-a-contact\",\n    \"36-1\": \"Gets a list of page views for a campaign after a specified date\",\n    \"37-1\": \"Gets a list of ROI information for a campaign for a contact\",\n    \"37-2\": \"https://developer.dotmailer.com/docs/get-campaign-roi-activity-for-a-contact\",\n    \"38-2\": \"https://developer.dotmailer.com/docs/get-campaign-roi-activity-since-date\",\n    \"38-1\": \"Retrieves a list of ROI information for a campaign after a specified date\",\n    \"39-1\": \"Gets campaign social bookmark views for a campaign\",\n    \"39-2\": \"https://developer.dotmailer.com/docs/get-campaign-social-bookmark-views\",\n    \"40-2\": \"https://developer.dotmailer.com/docs/get-campaign-social-bookmark-views-for-a-contact\",\n    \"40-1\": \"Gets campaign social bookmark views for a contact\",\n    \"41-1\": \"Gets a list of contacts who hard bounced when sent a particular campaign\",\n    \"41-2\": \"https://developer.dotmailer.com/docs/get-campaign-hard-bouncers\",\n    \"42-1\": \"Creates a contact\",\n    \"42-2\": \"https://developer.dotmailer.com/docs/create-contact\",\n    \"45-2\": \"https://developer.dotmailer.com/docs/delete-contact\",\n    \"45-1\": \"Deletes a contact by ID\",\n    \"46-1\": \"Updates a contact by ID\",\n    \"49-1\": \"Adds a contact to a given address book\",\n    \"50-1\": \"Deletes a contact from a given address book\",\n    \"51-1\": \"Deletes multiple contacts from an address book\",\n    \"52-1\": \"Deletes all contacts from a given address book\",\n    \"54-1\": \"Gets a contact by ID\",\n    \"53-1\": \"Gets a contact by email address\",\n    \"56-1\": \"Gets any address books that a contact is in\",\n    \"57-1\": \"Gets a list of all contacts in the account\",\n    \"58-1\": \"Gets a list of created contacts after a specified date\",\n    \"59-1\": \"Bulk creates, or bulk updates, contacts\",\n    \"60-1\": \"Bulk creates, or bulk updates, contacts in an address book\",\n    \"61-1\": \"Gets the import status of a previously started contact import\",\n    \"62-1\": \"Gets a report with statistics about what was successfully imported, and what was unable to be imported\",\n    \"63-1\": \"Gets all contact import records that were not successfully imported\",\n    \"64-1\": \"Gets a list of contacts in a given address book or segment by ID\",\n    \"65-1\": \"Gets a list of contacts who were modified since a given date, in a given address book or segment\",\n    \"66-1\": \"Gets a list of modified contacts after a specified date\",\n    \"67-1\": \"Gets a list of suppressed contacts after a given date along with the reason for suppression\",\n    \"68-1\": \"Gets a list of unsubscribed contacts who unsubscribed after a given date\",\n    \"69-1\": \"Gets a list of contacts who have unsubscribed since a given date from a given address book\",\n    \"70-1\": \"Unsubscribes contact from account\",\n    \"71-1\": \"Unsubscribes contact from a given address book\",\n    \"72-1\": \"Resubscribes a previously unsubscribed contact\",\n    \"74-1\": \"Resubscribes a previously unsubscribed contact to a given address book\",\n    \"76-1\": \"Gets contact scoring for all contacts in the account\",\n    \"77-1\": \"Gets contact scoring for contacts within a specific address book or segment\",\n    \"78-1\": \"Gets contacts whose contact scoring data has been modified since a given date\",\n    \"79-1\": \"Gets contact scoring for a contact by email address\",\n    \"80-1\": \"Gets contact scoring for a contact by ID\",\n    \"87-1\": \"Creates a contact data field within the account\",\n    \"88-1\": \"Delete a contact data field within the account\",\n    \"89-1\": \"Lists all contact data fields within the account\",\n    \"90-1\": \"Gets all custom from addresses which can be used in a campaign\",\n    \"91-1\": \"Creates a new document folder\",\n    \"92-1\": \"Fetches the document folder tree structure\",\n    \"93-1\": \"Gets all uploaded documents in a folder\",\n    \"94-1\": \"Upload a document to a specified folder\",\n    \"95-1\": \"Creates a new campaign image folder\",\n    \"96-1\": \"Fetches the campaign image folder tree structure\",\n    \"97-1\": \"Gets an image folder by ID\",\n    \"98-1\": \"Uploads a new campaign image to a specified folder\",\n    \"106-1\": \"Gets all programs\",\n    \"107-1\": \"Gets a program by ID\",\n    \"108-1\": \"Creates a program enrolment\",\n    \"109-1\": \"Gets all contacts that were not successfully enrolled, by enrolment ID\",\n    \"110-1\": \"Gets a program enrolment by ID\",\n    \"111-1\": \"Gets program enrolments by status\",\n    \"112-1\": \"Gets all segments\",\n    \"113-1\": \"Refreshes a segment by ID\",\n    \"114-1\": \"Gets the refresh progress for a segment\",\n    \"115-1\": \"Gets the UTC time as set on the server\",\n    \"116-1\": \"Sends a single SMS message\",\n    \"117-1\": \"Gets a list of all surveys in the account\",\n    \"118-1\": \"Gets a single survey by its ID\",\n    \"119-1\": \"Gets a list of survey pages, each containing a list of the fields on that page\",\n    \"120-1\": \"Gets a list of all responses for a survey\",\n    \"121-1\": \"Gets a list of responses that have changed since the specified date\",\n    \"122-1\": \"Gets a list of surveys in the account that have changed since the specified date\",\n    \"123-1\": \"Creates a template\",\n    \"124-1\": \"Gets a template by ID\",\n    \"125-1\": \"Gets list of all templates\",\n    \"126-1\": \"Updates a template\",\n    \"127-1\": \"Adds a single piece of transactional data to a contact\",\n    \"128-1\": \"Adds multiple pieces of transactional data to contacts asynchronously\",\n    \"129-1\": \"Gets the import status of a previously started transactional data import\",\n    \"130-1\": \"Gets a report with statistics about what transactional data was successfully imported, and what was unable to be imported\",\n    \"131-1\": \"Deletes all transactional data for a contact in a collection by their email address\",\n    \"132-1\": \"Gets a list of up to 100 of the most recent transactional data records for a contact in a collection by their email address\",\n    \"133-1\": \"Deletes all transactional data for a contact in a collection by their ID\",\n    \"134-1\": \"Replaces a piece of transactional data by key\",\n    \"135-1\": \"Deletes a piece of transactional data by key\",\n    \"136-1\": \"Gets a piece of transactional data by key\",\n    \"138-1\": \"Sends a transactional email\",\n    \"140-1\": \"Gets transactional email reporting statistics for a specified time period\",\n    \"46-2\": \"https://developer.dotmailer.com/docs/update-contact\",\n    \"49-2\": \"https://developer.dotmailer.com/docs/add-contact-to-address-book\",\n    \"50-2\": \"https://developer.dotmailer.com/docs/delete-contact-from-address-book\",\n    \"51-2\": \"https://developer.dotmailer.com/docs/delete-contacts-from-address-book\",\n    \"52-2\": \"https://developer.dotmailer.com/docs/delete-all-contacts-from-address-book\",\n    \"53-2\": \"https://developer.dotmailer.com/docs/get-contact-by-email\",\n    \"54-2\": \"https://developer.dotmailer.com/docs/get-contact-by-id\",\n    \"56-2\": \"https://developer.dotmailer.com/docs/get-contact-address-books\",\n    \"57-2\": \"https://developer.dotmailer.com/docs/get-contacts\",\n    \"58-2\": \"https://developer.dotmailer.com/docs/get-contacts-created-since-date\",\n    \"59-2\": \"https://developer.dotmailer.com/docs/bulk-create-contacts\",\n    \"60-2\": \"https://developer.dotmailer.com/docs/bulk-create-contacts-in-address-book\",\n    \"61-2\": \"https://developer.dotmailer.com/docs/get-contact-import-status\",\n    \"62-2\": \"https://developer.dotmailer.com/docs/get-contact-import-report\",\n    \"63-2\": \"https://developer.dotmailer.com/docs/get-contact-import-report-faults\",\n    \"64-2\": \"https://developer.dotmailer.com/docs/get-contacts-from-address-book\",\n    \"65-2\": \"https://developer.dotmailer.com/docs/get-modified-contacts-in-address-book-since-date\",\n    \"66-2\": \"https://developer.dotmailer.com/docs/get-modified-contacts-since-date\",\n    \"67-2\": \"https://developer.dotmailer.com/docs/get-suppressed-contacts-since-date\",\n    \"68-2\": \"https://developer.dotmailer.com/docs/get-unsubscribed-contacts-since-date\",\n    \"70-2\": \"https://developer.dotmailer.com/docs/unsubscribe-contact\",\n    \"69-2\": \"https://developer.dotmailer.com/docs/get-unsubscribed-contacts-from-address-book-since-date\",\n    \"71-2\": \"https://developer.dotmailer.com/docs/unsubscribe-contact-from-address-book\",\n    \"72-2\": \"https://developer.dotmailer.com/docs/resubscribe-contact\",\n    \"74-2\": \"https://developer.dotmailer.com/docs/resubscribe-contact-to-address-book\",\n    \"76-2\": \"https://developer.dotmailer.com/docs/get-lead-scoring-for-contacts\",\n    \"77-2\": \"https://developer.dotmailer.com/docs/get-lead-scoring-for-contacts-in-address-book\",\n    \"78-2\": \"https://developer.dotmailer.com/docs/get-lead-scoring-modified-since-date-for-contacts\",\n    \"79-2\": \"https://developer.dotmailer.com/docs/get-lead-scoring-for-contact-by-email\",\n    \"80-2\": \"https://developer.dotmailer.com/docs/get-lead-scoring-for-contact-by-id\",\n    \"87-2\": \"https://developer.dotmailer.com/docs/create-contact-data-field\",\n    \"88-2\": \"https://developer.dotmailer.com/docs/delete-contact-data-field\",\n    \"89-2\": \"https://developer.dotmailer.com/docs/get-contact-data-fields\",\n    \"90-2\": \"https://developer.dotmailer.com/docs/get-custom-from-addresses\",\n    \"91-2\": \"https://developer.dotmailer.com/docs/create-document-folder\",\n    \"92-2\": \"https://developer.dotmailer.com/docs/get-document-folders\",\n    \"93-2\": \"https://developer.dotmailer.com/docs/get-documents-in-folder\",\n    \"94-2\": \"https://developer.dotmailer.com/docs/upload-document\",\n    \"95-2\": \"https://developer.dotmailer.com/docs/create-image-folder\",\n    \"106-2\": \"https://developer.dotmailer.com/docs/get-programs\",\n    \"112-2\": \"https://developer.dotmailer.com/docs/get-segments\",\n    \"115-2\": \"https://developer.dotmailer.com/docs/get-server-time\",\n    \"116-2\": \"https://developer.dotmailer.com/docs/send-sms-message\",\n    \"117-2\": \"https://developer.dotmailer.com/docs/get-surveys\",\n    \"123-2\": \"https://developer.dotmailer.com/docs/create-template\",\n    \"127-2\": \"https://developer.dotmailer.com/docs/add-transactional-data-to-contact\",\n    \"138-2\": \"https://developer.dotmailer.com/docs/send-transactional-email\",\n    \"140-2\": \"https://developer.dotmailer.com/docs/get-transactional-email-statistics\",\n    \"96-2\": \"https://developer.dotmailer.com/docs/get-image-folders\",\n    \"97-2\": \"https://developer.dotmailer.com/docs/get-image-folder-by-id\",\n    \"98-2\": \"https://developer.dotmailer.com/docs/upload-campaign-image\",\n    \"107-2\": \"https://developer.dotmailer.com/docs/get-program-by-id\",\n    \"108-2\": \"https://developer.dotmailer.com/docs/create-program-enrolment\",\n    \"109-2\": \"https://developer.dotmailer.com/docs/get-program-enrolment-report-faults\",\n    \"110-2\": \"https://developer.dotmailer.com/docs/get-program-enrolment\",\n    \"111-2\": \"https://developer.dotmailer.com/docs/get-program-enrolment-by-status\",\n    \"113-2\": \"https://developer.dotmailer.com/docs/refresh-segment\",\n    \"114-2\": \"https://developer.dotmailer.com/docs/get-refresh-progress-for-segment\",\n    \"118-2\": \"https://developer.dotmailer.com/docs/get-survey-by-id\",\n    \"119-2\": \"https://developer.dotmailer.com/docs/get-survey-fields\",\n    \"120-2\": \"https://developer.dotmailer.com/docs/get-survey-responses\",\n    \"121-2\": \"https://developer.dotmailer.com/docs/get-survey-responses-with-activity-since-date\",\n    \"122-2\": \"https://developer.dotmailer.com/docs/get-surveys-with-activity-since-date\",\n    \"124-2\": \"https://developer.dotmailer.com/docs/get-template-by-id\",\n    \"125-2\": \"https://developer.dotmailer.com/docs/get-templates\",\n    \"126-2\": \"https://developer.dotmailer.com/docs/update-template\",\n    \"128-2\": \"https://developer.dotmailer.com/docs/bulk-add-transactional-data-to-contacts\",\n    \"129-2\": \"https://developer.dotmailer.com/docs/get-transactional-data-import-status\",\n    \"130-2\": \"https://developer.dotmailer.com/docs/get-transactional-data-import-report\",\n    \"131-2\": \"https://developer.dotmailer.com/docs/delete-transactional-data-collection-for-contact-by-email\",\n    \"132-2\": \"https://developer.dotmailer.com/docs/get-transactional-data-collection-for-contact-by-email\",\n    \"133-2\": \"https://developer.dotmailer.com/docs/delete-transactional-data-collection-for-contact-by-id\",\n    \"134-2\": \"https://developer.dotmailer.com/docs/replace-transactional-data-by-key\",\n    \"135-2\": \"https://developer.dotmailer.com/docs/delete-transactional-data-by-key\",\n    \"136-2\": \"https://developer.dotmailer.com/docs/get-transactional-data-by-key\",\n    \"139-0\": \"[Send transactional email using a triggered campaign](doc:send-transactional-email-using-a-triggered-campaign)\",\n    \"139-1\": \"Sends a transactional email using a triggered campaign\",\n    \"1-0\": \"[Empty recycle bin](doc:empty-recycle-bin)\",\n    \"1-1\": \"Permanently deletes everything in the recycle bin\",\n    \"43-0\": \"[Create contact with consent](doc:create-contact-with-consent)\",\n    \"43-1\": \"Creates a contact with their consent information\",\n    \"47-0\": \"[Update contact with consent](doc:update-contact-with-consent)\",\n    \"47-1\": \"Updates a contact by ID with their consent information\",\n    \"99-0\": \"[Create preference](doc:create-preference)\",\n    \"99-1\": \"Creates a new preference or preference category\",\n    \"100-0\": \"[Set preferences for contact](doc:set-preferences-for-contact)\",\n    \"100-1\": \"Opts in a contact to preferences\",\n    \"101-0\": \"[Update preference](doc:update-preference)\",\n    \"101-1\": \"Updates a preference or preference category\",\n    \"102-0\": \"[Delete preference](doc:delete-preference)\",\n    \"102-1\": \"Deletes a preference or preference category\",\n    \"103-0\": \"[Get preferences](doc:get-preferences)\",\n    \"103-1\": \"Gets all preferences and preference categories\",\n    \"104-0\": \"[Get modified preferences since date](doc:get-modified-preferences-since-date)\",\n    \"104-1\": \"Gets all preferences and preference categories that have been modified since a given date\",\n    \"105-0\": \"[Get preferences for contact](doc:get-preferences-for-contact)\",\n    \"105-1\": \"Gets all the preferences that a given contact is opted into\",\n    \"44-0\": \"[Create contact with consent and preferences](doc:create-contact-with-consent-and-preferences)\",\n    \"44-1\": \"Creates a contact with their consent and preference information\",\n    \"48-0\": \"[Update contact with consent and preferences](doc:update-contact-with-consent-and-preferences)\",\n    \"48-1\": \"Updates a contact by ID with their consent and preference information\",\n    \"73-0\": \"[Resubscribe contact with no challenge](doc:resubscribe-contact-with-no-challenge)\",\n    \"73-1\": \"Resubscribes a previously unsubscribed contact without sending a challenge email\",\n    \"75-0\": \"[Resubscribe contact to address book with no challenge](doc:resubscribe-contact-to-address-book-with-no-challenge)\",\n    \"75-1\": \"Resubscribes a previously unsubscribed contact to a given address book without sending a challenge email\",\n    \"81-0\": \"[Get contact by ID with consent](doc:get-contact-by-id-with-consent)\",\n    \"81-1\": \"Gets a contact by ID with their consent information\",\n    \"82-1\": \"Gets a contact by email with their consent information\",\n    \"82-0\": \"[Get contact by email with consent](doc:get-contact-by-email-with-consent)\",\n    \"83-0\": \"[Get contacts opted into a preference and an address book](doc:get-contacts-opted-into-a-preference-and-an-address-book)\",\n    \"83-1\": \"Gets contacts who are opted into a given preference and a given address book\",\n    \"84-0\": \"[Get contacts opted into a preference](doc:get-contacts-opted-into-a-preference)\",\n    \"84-1\": \"Gets contacts who are opted into a given preference\",\n    \"85-0\": \"[Get contacts with modified preference opt-in since date](doc:get-contacts-with-modified-preference-opt-in-since-date)\",\n    \"85-1\": \"Gets contacts who have had their specified preference opt-in status modified since a given date\",\n    \"86-0\": \"[Get contacts with modified preference opt-in in address book since date](doc:get-contacts-with-modified-preference-opt-in-in-address-book-since-date)\",\n    \"86-1\": \"Gets contacts who have had a specific preference opt-in status modified since a given date, in a given address book\",\n    \"55-0\": \"[Get all contacts count](doc:get-all-contacts-count)\",\n    \"55-1\": \"Gets the total number of contacts in the account\",\n    \"137-0\": \"[Get account scoped transactional data](doc:get-account-scoped-transactional-data)\",\n    \"137-1\": \"Gets transactional data in a collection at account level\"\n  },\n  \"cols\": 2,\n  \"rows\": 141\n}\n[/block]","excerpt":"","slug":"rest-api-quick-reference","type":"basic","title":"REST API quick reference"}

API overview

Push notifications

REST

Account information

Address books

Campaigns

Contacts

Contact data fields

Custom from addresses

Document folders

Image folders

Preferences

Product recommendations

Programs

Segments

Server time

SMS

Surveys and forms

Templates

Transactional data

Transactional email

SOAP

Account information

Address books

Campaigns

Contacts

Contact data fields

Custom from addresses

Document folders

Image folders

Preferences

Product recommendations

Programs

Segments

Server time

SMS

Surveys and forms

Templates

Transactional data

Transactional email

More help

REST API quick reference

All of our API's REST operations are listed below. Quickly scan for the method you're looking for and go straight to the documentation for it. [block:parameters] { "data": { "h-0": "Operation", "h-1": "Description", "h-2": "Page link", "0-0": "[Get account information](doc:get-account-information)", "0-1": "Gets a summary of information about the current status of the account", "0-2": "https://developer.dotmailer.com/docs/get-account-information", "2-0": "[Create address book](doc:create-address-book)", "2-1": "Creates an address book", "2-2": "https://developer.dotmailer.com/docs/create-address-book", "3-0": "[Delete address book](doc:delete-address-book)", "3-1": "Deletes an address book by ID", "3-2": "https://developer.dotmailer.com/docs/delete-address-book", "4-0": "[Update address book](doc:update-address-book)", "4-1": "Updates an address book by ID", "4-2": "https://developer.dotmailer.com/docs/update-address-book", "5-1": "Gets an address book by ID", "5-2": "https://developer.dotmailer.com/docs/get-address-book", "5-0": "[Gets an address book by ID](doc:get-address-book)", "6-0": "[Get address books](doc:get-address-books)", "6-1": "Gets all address books", "6-2": "https://developer.dotmailer.com/docs/get-address-books", "7-2": "https://developer.dotmailer.com/docs/get-private-address-books", "7-1": "Gets all private address books", "7-0": "[Get private address books](doc:get-private-address-books)", "8-0": "[Get public address books](doc:get-public-address-books)", "8-1": "Gets all public address books", "8-2": "https://developer.dotmailer.com/docs/get-public-address-books", "9-0": "[Create campaign](doc:create-campaign)", "10-0": "[Update campaign](doc:update-campaign)", "11-0": "[Copy campaign](doc:copy-campaign)", "12-0": "[Delete campaign](doc:delete-campaign)", "13-0": "[Send campaign](doc:send-campaign)", "14-0": "[Send time optimised campaign](doc:send-time-optimised-campaign)", "15-0": "[Get campaign send status](doc:get-campaign-send-status)", "16-0": "[Add campaign attachment](doc:add-campaign-attachment)", "17-0": "[Remove campaign attachment](doc:remove-campaign-attachment)", "18-0": "[Get campaign attachments](doc:get-campaign-attachments)", "19-0": "[Get all campaigns](doc:get-all-campaigns)", "20-0": "[Get campaigns sent to address book or segment](doc:get-campaigns-sent-to-address-book-or-segment)", "21-0": "[Get campaign](doc:get-campaign)", "22-0": "[Get campaign summary](doc:get-campaign-summary)", "23-0": "[Get campaign opens](doc:get-campaign-opens)", "24-0": "[Get campaign opens for a contact](doc:get-campaign-opens-for-a-contact)", "25-0": "[Get campaign activity for a contact](doc:get-campaign-activity-for-a-contact)", "26-0": "[Get campaign activity since date](doc:get-campaign-activity-since-date)", "27-0": "[Get campaign clicks](doc:get-campaign-clicks)", "28-0": "[Get campaign clicks since date](doc:get-campaign-clicks-since-date)", "29-0": "[Get campaign opens since date](doc:get-campaign-opens-since-date)", "30-0": "[Get campaign activity](doc:get-campaign-activity)", "31-0": "[Get campaign address books](doc:get-campaign-address-books)", "32-0": "[Get campaign clicks for a contact](doc:get-campaign-clicks-for-a-contact)", "33-0": "[Get campaigns with activity since date](doc:get-campaigns-with-activity-since-date)", "34-0": "[Get campaign page views for a contact](doc:get-campaign-page-views-for-a-contact)", "35-0": "[Get campaign page views since date](doc:get-campaign-page-views-since-date)", "36-0": "[Get campaign replies for a contact](doc:get-campaign-replies-for-a-contact)", "37-0": "[Get campaign ROI activity for a contact](doc:get-campaign-roi-activity-for-a-contact)", "38-0": "[Get campaign ROI activity since date](doc:get-campaign-roi-activity-since-date)", "39-0": "[Get campaign social bookmark views](doc:get-campaign-social-bookmark-views)", "40-0": "[Get campaign social bookmark views for a contact](doc:get-campaign-social-bookmark-views-for-a-contact)", "41-0": "[Get campaign hard bouncers](doc:get-campaign-hard-bouncers)", "42-0": "[Create contact](doc:create-contact)", "45-0": "[Delete contact](doc:delete-contact)", "46-0": "[Update contact](doc:update-contact)", "49-0": "[Add contact to address book](doc:add-contact-to-address-book)", "50-0": "[Delete contact from address book](doc:delete-contact-from-address-book)", "51-0": "[Delete contacts from address book](doc:delete-contacts-from-address-book)", "52-0": "[Delete all contacts from address book](doc:delete-all-contacts-from-address-book)", "53-0": "[Get contact by email](doc:get-contact-by-email)", "54-0": "[Get contact by ID](doc:get-contact-by-id)", "56-0": "[Get contact address books](doc:get-contact-address-books)", "57-0": "[Get contacts](doc:get-contacts)", "58-0": "[Get contacts created since date](doc:get-contacts-created-since-date)", "59-0": "[Bulk create contacts](doc:bulk-create-contacts)", "60-0": "[Bulk create contacts in address book](doc:bulk-create-contacts-in-address-book)", "61-0": "[Get contact import status](doc:get-contact-import-status)", "62-0": "[Get contact import report](doc:get-contact-import-report)", "63-0": "[Get contact import report faults](doc:get-contact-import-report-faults)", "64-0": "[Get contacts from address book](doc:get-contacts-from-address-book)", "65-0": "[Get modified contacts in address book since date](doc:get-modified-contacts-in-address-book-since-date)", "66-0": "[Get modified contacts since date](doc:get-modified-contacts-since-date)", "67-0": "[Get suppressed contacts since date](doc:get-suppressed-contacts-since-date)", "68-0": "[Get unsubscribed contacts since date](doc:get-unsubscribed-contacts-since-date)", "69-0": "[Get unsubscribed contacts from address book since date](doc:get-unsubscribed-contacts-from-address-book-since-date)", "70-0": "[Unsubscribe contact](doc:unsubscribe-contact)", "71-0": "[Unsubscribe contact from address book](doc:unsubscribe-contact-from-address-book)", "72-0": "[Resubscribe contact](doc:resubscribe-contact)", "74-0": "[Resubscribe contact to address book](doc:resubscribe-contact-to-address-book)", "76-0": "[Get scoring for contacts](doc:get-scoring-for-contacts)", "77-0": "[Get scoring for contacts in address book](doc:get-scoring-for-contacts-in-address-book)", "78-0": "[Get scoring modified since date for contacts](doc:get-scoring-modified-since-date-for-contacts)", "79-0": "[Get scoring for contact by email](doc:get-scoring-for-contact-by-email)", "80-0": "[Get scoring for contact by ID](doc:get-scoring-for-contact-by-id)", "87-0": "[Create contact data field](doc:create-contact-data-field)", "88-0": "[Delete contact data field](doc:delete-contact-data-field)", "89-0": "[Get contact data fields](doc:get-contact-data-fields)", "90-0": "[Get custom from addresses](doc:get-custom-from-addresses)", "91-0": "[Create document folder](doc:create-document-folder)", "92-0": "[Get document folders](doc:get-document-folders)", "93-0": "[Get documents in folder](doc:get-documents-in-folder)", "94-0": "[Upload document](doc:upload-document)", "95-0": "[Create image folder](doc:create-image-folder)", "96-0": "[Get image folders](doc:get-image-folders)", "97-0": "[Get image folder by ID](doc:get-image-folder-by-id)", "98-0": "[Upload campaign image](doc:upload-campaign-image)", "106-0": "[Get programs](doc:get-programs)", "107-0": "[Get program by ID](doc:get-program-by-id)", "108-0": "[Create program enrolment](doc:create-program-enrolment)", "109-0": "[Get program enrolment report faults](doc:get-program-enrolment-report-faults)", "110-0": "[Get program enrolment](doc:get-program-enrolment)", "111-0": "[Get program enrolments by status](doc:get-program-enrolment-by-status)", "112-0": "[Get segments](doc:get-segments)", "113-0": "[Refresh segment](doc:refresh-segment)", "114-0": "[Get refresh progress for segment](doc:get-refresh-progress-for-segment)", "115-0": "[Get server time](doc:get-server-time)", "116-0": "[Send SMS message](doc:send-sms-message)", "117-0": "[Get surveys](doc:get-surveys)", "118-0": "[Get survey by ID](doc:get-survey-by-id)", "119-0": "[Get survey fields](doc:get-survey-fields)", "120-0": "[Get survey responses](doc:get-survey-responses)", "121-0": "[Get survey responses with activity since date](doc:get-survey-responses-with-activity-since-date)", "122-0": "[Get surveys with activity since date](doc:get-surveys-with-activity-since-date)", "123-0": "[Create template](doc:create-template)", "124-0": "[Get template by ID](doc:get-template-by-id)", "125-0": "[Get templates](doc:get-templates)", "126-0": "[Update template](doc:update-template)", "127-0": "[Add transactional data to contact](doc:add-transactional-data-to-contact)", "128-0": "[Bulk add transactional data to contacts](doc:bulk-add-transactional-data-to-contacts)", "129-0": "[Get transactional data import status](doc:get-transactional-data-import-status)", "130-0": "[Get transactional data import report](doc:get-transactional-data-import-report)", "131-0": "[Delete transactional data collection for contact by email](doc:delete-transactional-data-collection-for-contact-by-email)", "132-0": "[Get transactional data collection for contact by email](doc:get-transactional-data-collection-for-contact-by-email)", "133-0": "[Delete transactional data collection for contact by ID](doc:delete-transactional-data-collection-for-contact-by-id)", "134-0": "[Replace transactional data by key](doc:replace-transactional-data-by-key)", "135-0": "[Delete transactional data by key](doc:delete-transactional-data-by-key)", "136-0": "[Get transactional data by key](doc:get-transactional-data-by-key)", "138-0": "[Send transactional email](doc:send-transactional-email)", "140-0": "[Get transactional email statistics](doc:get-transactional-email-statistics)", "9-1": "Creates a campaign", "9-2": "https://developer.dotmailer.com/docs/create-campaign", "10-2": "https://developer.dotmailer.com/docs/update-campaign", "10-1": "Updates a given campaign", "11-1": "Copies a given campaign, returning the new campaign", "11-2": "https://developer.dotmailer.com/docs/copy-campaign", "12-1": "Deletes a campaign", "12-2": "https://developer.dotmailer.com/docs/delete-campaign", "13-1": "Sends a specified campaign to one or more address books, segments or contacts, either as an immediate or scheduled send", "13-2": "https://developer.dotmailer.com/docs/send-campaign", "14-1": "Sends a specified campaign to one or more address books, segments or contacts at the most appropriate time based upon their previous opens", "14-2": "https://developer.dotmailer.com/docs/send-time-optimised-campaign", "15-1": "Gets a campaign send status using send ID", "15-2": "https://developer.dotmailer.com/docs/get-campaign-send-status", "16-1": "Adds a document to a campaign as an attachment", "16-2": "https://developer.dotmailer.com/docs/add-campaign-attachment", "17-1": "Removes an attachment from a campaign", "17-2": "https://developer.dotmailer.com/docs/remove-campaign-attachment", "18-2": "https://developer.dotmailer.com/docs/get-campaign-attachments", "18-1": "Gets documents that are currently attached to a campaign", "19-1": "Gets all campaigns", "19-2": "https://developer.dotmailer.com/docs/get-all-campaigns", "20-2": "https://developer.dotmailer.com/docs/get-campaigns-sent-to-address-book-or-segment", "20-1": "Gets any campaigns that have been sent to an address book or a segment", "21-1": "Gets a campaign by ID", "21-2": "https://developer.dotmailer.com/docs/get-campaign", "22-1": "Gets a summary of reporting information for a specified campaign", "22-2": "https://developer.dotmailer.com/docs/get-campaign-summary", "23-2": "https://developer.dotmailer.com/docs/get-campaign-opens", "23-1": "Gets a list of campaign opens", "24-1": "Gets a list of campaign opens for a contact", "24-2": "https://developer.dotmailer.com/docs/get-campaign-opens-for-a-contact", "25-1": "Gets activity for a given contact and given campaign", "25-2": "https://developer.dotmailer.com/docs/get-campaign-activity-for-a-contact", "26-1": "Gets a list of contacts who were sent a campaign, and retrieves only those contacts who showed activity (e.g. they clicked, opened) after a specified date", "26-2": "https://developer.dotmailer.com/docs/get-campaign-activity-since-date", "27-1": "Gets a list of campaign link clicks", "27-2": "https://developer.dotmailer.com/docs/get-campaign-clicks", "28-1": "Gets a list of link clicks for a campaign after a specified date", "28-2": "https://developer.dotmailer.com/docs/get-campaign-clicks-since-date", "29-1": "Gets a list of opens for a campaign after a specified date", "29-2": "https://developer.dotmailer.com/docs/get-campaign-opens-since-date", "30-2": "https://developer.dotmailer.com/docs/get-campaign-activity", "30-1": "Gets a list of contacts who were sent a campaign, with their activity", "31-1": "Gets any address books and segments that a campaign has ever been sent to", "31-2": "https://developer.dotmailer.com/docs/get-campaign-address-books", "32-1": "Gets a list of campaign link clicks for a contact", "32-2": "https://developer.dotmailer.com/docs/get-campaign-clicks-for-a-contact", "33-1": "Gets all sent campaigns, which have had activity (e.g. clicks, opens) after a specified date", "33-2": "https://developer.dotmailer.com/docs/get-campaigns-with-activity-since-date", "34-1": "Gets a list of page views for a specific campaign for a contact", "34-2": "https://developer.dotmailer.com/docs/get-campaign-page-views-for-a-contact", "35-1": "Gets a list of page views for a campaign after a specified date", "35-2": "https://developer.dotmailer.com/docs/get-campaign-page-views-since-date", "36-2": "https://developer.dotmailer.com/docs/get-campaign-replies-for-a-contact", "36-1": "Gets a list of page views for a campaign after a specified date", "37-1": "Gets a list of ROI information for a campaign for a contact", "37-2": "https://developer.dotmailer.com/docs/get-campaign-roi-activity-for-a-contact", "38-2": "https://developer.dotmailer.com/docs/get-campaign-roi-activity-since-date", "38-1": "Retrieves a list of ROI information for a campaign after a specified date", "39-1": "Gets campaign social bookmark views for a campaign", "39-2": "https://developer.dotmailer.com/docs/get-campaign-social-bookmark-views", "40-2": "https://developer.dotmailer.com/docs/get-campaign-social-bookmark-views-for-a-contact", "40-1": "Gets campaign social bookmark views for a contact", "41-1": "Gets a list of contacts who hard bounced when sent a particular campaign", "41-2": "https://developer.dotmailer.com/docs/get-campaign-hard-bouncers", "42-1": "Creates a contact", "42-2": "https://developer.dotmailer.com/docs/create-contact", "45-2": "https://developer.dotmailer.com/docs/delete-contact", "45-1": "Deletes a contact by ID", "46-1": "Updates a contact by ID", "49-1": "Adds a contact to a given address book", "50-1": "Deletes a contact from a given address book", "51-1": "Deletes multiple contacts from an address book", "52-1": "Deletes all contacts from a given address book", "54-1": "Gets a contact by ID", "53-1": "Gets a contact by email address", "56-1": "Gets any address books that a contact is in", "57-1": "Gets a list of all contacts in the account", "58-1": "Gets a list of created contacts after a specified date", "59-1": "Bulk creates, or bulk updates, contacts", "60-1": "Bulk creates, or bulk updates, contacts in an address book", "61-1": "Gets the import status of a previously started contact import", "62-1": "Gets a report with statistics about what was successfully imported, and what was unable to be imported", "63-1": "Gets all contact import records that were not successfully imported", "64-1": "Gets a list of contacts in a given address book or segment by ID", "65-1": "Gets a list of contacts who were modified since a given date, in a given address book or segment", "66-1": "Gets a list of modified contacts after a specified date", "67-1": "Gets a list of suppressed contacts after a given date along with the reason for suppression", "68-1": "Gets a list of unsubscribed contacts who unsubscribed after a given date", "69-1": "Gets a list of contacts who have unsubscribed since a given date from a given address book", "70-1": "Unsubscribes contact from account", "71-1": "Unsubscribes contact from a given address book", "72-1": "Resubscribes a previously unsubscribed contact", "74-1": "Resubscribes a previously unsubscribed contact to a given address book", "76-1": "Gets contact scoring for all contacts in the account", "77-1": "Gets contact scoring for contacts within a specific address book or segment", "78-1": "Gets contacts whose contact scoring data has been modified since a given date", "79-1": "Gets contact scoring for a contact by email address", "80-1": "Gets contact scoring for a contact by ID", "87-1": "Creates a contact data field within the account", "88-1": "Delete a contact data field within the account", "89-1": "Lists all contact data fields within the account", "90-1": "Gets all custom from addresses which can be used in a campaign", "91-1": "Creates a new document folder", "92-1": "Fetches the document folder tree structure", "93-1": "Gets all uploaded documents in a folder", "94-1": "Upload a document to a specified folder", "95-1": "Creates a new campaign image folder", "96-1": "Fetches the campaign image folder tree structure", "97-1": "Gets an image folder by ID", "98-1": "Uploads a new campaign image to a specified folder", "106-1": "Gets all programs", "107-1": "Gets a program by ID", "108-1": "Creates a program enrolment", "109-1": "Gets all contacts that were not successfully enrolled, by enrolment ID", "110-1": "Gets a program enrolment by ID", "111-1": "Gets program enrolments by status", "112-1": "Gets all segments", "113-1": "Refreshes a segment by ID", "114-1": "Gets the refresh progress for a segment", "115-1": "Gets the UTC time as set on the server", "116-1": "Sends a single SMS message", "117-1": "Gets a list of all surveys in the account", "118-1": "Gets a single survey by its ID", "119-1": "Gets a list of survey pages, each containing a list of the fields on that page", "120-1": "Gets a list of all responses for a survey", "121-1": "Gets a list of responses that have changed since the specified date", "122-1": "Gets a list of surveys in the account that have changed since the specified date", "123-1": "Creates a template", "124-1": "Gets a template by ID", "125-1": "Gets list of all templates", "126-1": "Updates a template", "127-1": "Adds a single piece of transactional data to a contact", "128-1": "Adds multiple pieces of transactional data to contacts asynchronously", "129-1": "Gets the import status of a previously started transactional data import", "130-1": "Gets a report with statistics about what transactional data was successfully imported, and what was unable to be imported", "131-1": "Deletes all transactional data for a contact in a collection by their email address", "132-1": "Gets a list of up to 100 of the most recent transactional data records for a contact in a collection by their email address", "133-1": "Deletes all transactional data for a contact in a collection by their ID", "134-1": "Replaces a piece of transactional data by key", "135-1": "Deletes a piece of transactional data by key", "136-1": "Gets a piece of transactional data by key", "138-1": "Sends a transactional email", "140-1": "Gets transactional email reporting statistics for a specified time period", "46-2": "https://developer.dotmailer.com/docs/update-contact", "49-2": "https://developer.dotmailer.com/docs/add-contact-to-address-book", "50-2": "https://developer.dotmailer.com/docs/delete-contact-from-address-book", "51-2": "https://developer.dotmailer.com/docs/delete-contacts-from-address-book", "52-2": "https://developer.dotmailer.com/docs/delete-all-contacts-from-address-book", "53-2": "https://developer.dotmailer.com/docs/get-contact-by-email", "54-2": "https://developer.dotmailer.com/docs/get-contact-by-id", "56-2": "https://developer.dotmailer.com/docs/get-contact-address-books", "57-2": "https://developer.dotmailer.com/docs/get-contacts", "58-2": "https://developer.dotmailer.com/docs/get-contacts-created-since-date", "59-2": "https://developer.dotmailer.com/docs/bulk-create-contacts", "60-2": "https://developer.dotmailer.com/docs/bulk-create-contacts-in-address-book", "61-2": "https://developer.dotmailer.com/docs/get-contact-import-status", "62-2": "https://developer.dotmailer.com/docs/get-contact-import-report", "63-2": "https://developer.dotmailer.com/docs/get-contact-import-report-faults", "64-2": "https://developer.dotmailer.com/docs/get-contacts-from-address-book", "65-2": "https://developer.dotmailer.com/docs/get-modified-contacts-in-address-book-since-date", "66-2": "https://developer.dotmailer.com/docs/get-modified-contacts-since-date", "67-2": "https://developer.dotmailer.com/docs/get-suppressed-contacts-since-date", "68-2": "https://developer.dotmailer.com/docs/get-unsubscribed-contacts-since-date", "70-2": "https://developer.dotmailer.com/docs/unsubscribe-contact", "69-2": "https://developer.dotmailer.com/docs/get-unsubscribed-contacts-from-address-book-since-date", "71-2": "https://developer.dotmailer.com/docs/unsubscribe-contact-from-address-book", "72-2": "https://developer.dotmailer.com/docs/resubscribe-contact", "74-2": "https://developer.dotmailer.com/docs/resubscribe-contact-to-address-book", "76-2": "https://developer.dotmailer.com/docs/get-lead-scoring-for-contacts", "77-2": "https://developer.dotmailer.com/docs/get-lead-scoring-for-contacts-in-address-book", "78-2": "https://developer.dotmailer.com/docs/get-lead-scoring-modified-since-date-for-contacts", "79-2": "https://developer.dotmailer.com/docs/get-lead-scoring-for-contact-by-email", "80-2": "https://developer.dotmailer.com/docs/get-lead-scoring-for-contact-by-id", "87-2": "https://developer.dotmailer.com/docs/create-contact-data-field", "88-2": "https://developer.dotmailer.com/docs/delete-contact-data-field", "89-2": "https://developer.dotmailer.com/docs/get-contact-data-fields", "90-2": "https://developer.dotmailer.com/docs/get-custom-from-addresses", "91-2": "https://developer.dotmailer.com/docs/create-document-folder", "92-2": "https://developer.dotmailer.com/docs/get-document-folders", "93-2": "https://developer.dotmailer.com/docs/get-documents-in-folder", "94-2": "https://developer.dotmailer.com/docs/upload-document", "95-2": "https://developer.dotmailer.com/docs/create-image-folder", "106-2": "https://developer.dotmailer.com/docs/get-programs", "112-2": "https://developer.dotmailer.com/docs/get-segments", "115-2": "https://developer.dotmailer.com/docs/get-server-time", "116-2": "https://developer.dotmailer.com/docs/send-sms-message", "117-2": "https://developer.dotmailer.com/docs/get-surveys", "123-2": "https://developer.dotmailer.com/docs/create-template", "127-2": "https://developer.dotmailer.com/docs/add-transactional-data-to-contact", "138-2": "https://developer.dotmailer.com/docs/send-transactional-email", "140-2": "https://developer.dotmailer.com/docs/get-transactional-email-statistics", "96-2": "https://developer.dotmailer.com/docs/get-image-folders", "97-2": "https://developer.dotmailer.com/docs/get-image-folder-by-id", "98-2": "https://developer.dotmailer.com/docs/upload-campaign-image", "107-2": "https://developer.dotmailer.com/docs/get-program-by-id", "108-2": "https://developer.dotmailer.com/docs/create-program-enrolment", "109-2": "https://developer.dotmailer.com/docs/get-program-enrolment-report-faults", "110-2": "https://developer.dotmailer.com/docs/get-program-enrolment", "111-2": "https://developer.dotmailer.com/docs/get-program-enrolment-by-status", "113-2": "https://developer.dotmailer.com/docs/refresh-segment", "114-2": "https://developer.dotmailer.com/docs/get-refresh-progress-for-segment", "118-2": "https://developer.dotmailer.com/docs/get-survey-by-id", "119-2": "https://developer.dotmailer.com/docs/get-survey-fields", "120-2": "https://developer.dotmailer.com/docs/get-survey-responses", "121-2": "https://developer.dotmailer.com/docs/get-survey-responses-with-activity-since-date", "122-2": "https://developer.dotmailer.com/docs/get-surveys-with-activity-since-date", "124-2": "https://developer.dotmailer.com/docs/get-template-by-id", "125-2": "https://developer.dotmailer.com/docs/get-templates", "126-2": "https://developer.dotmailer.com/docs/update-template", "128-2": "https://developer.dotmailer.com/docs/bulk-add-transactional-data-to-contacts", "129-2": "https://developer.dotmailer.com/docs/get-transactional-data-import-status", "130-2": "https://developer.dotmailer.com/docs/get-transactional-data-import-report", "131-2": "https://developer.dotmailer.com/docs/delete-transactional-data-collection-for-contact-by-email", "132-2": "https://developer.dotmailer.com/docs/get-transactional-data-collection-for-contact-by-email", "133-2": "https://developer.dotmailer.com/docs/delete-transactional-data-collection-for-contact-by-id", "134-2": "https://developer.dotmailer.com/docs/replace-transactional-data-by-key", "135-2": "https://developer.dotmailer.com/docs/delete-transactional-data-by-key", "136-2": "https://developer.dotmailer.com/docs/get-transactional-data-by-key", "139-0": "[Send transactional email using a triggered campaign](doc:send-transactional-email-using-a-triggered-campaign)", "139-1": "Sends a transactional email using a triggered campaign", "1-0": "[Empty recycle bin](doc:empty-recycle-bin)", "1-1": "Permanently deletes everything in the recycle bin", "43-0": "[Create contact with consent](doc:create-contact-with-consent)", "43-1": "Creates a contact with their consent information", "47-0": "[Update contact with consent](doc:update-contact-with-consent)", "47-1": "Updates a contact by ID with their consent information", "99-0": "[Create preference](doc:create-preference)", "99-1": "Creates a new preference or preference category", "100-0": "[Set preferences for contact](doc:set-preferences-for-contact)", "100-1": "Opts in a contact to preferences", "101-0": "[Update preference](doc:update-preference)", "101-1": "Updates a preference or preference category", "102-0": "[Delete preference](doc:delete-preference)", "102-1": "Deletes a preference or preference category", "103-0": "[Get preferences](doc:get-preferences)", "103-1": "Gets all preferences and preference categories", "104-0": "[Get modified preferences since date](doc:get-modified-preferences-since-date)", "104-1": "Gets all preferences and preference categories that have been modified since a given date", "105-0": "[Get preferences for contact](doc:get-preferences-for-contact)", "105-1": "Gets all the preferences that a given contact is opted into", "44-0": "[Create contact with consent and preferences](doc:create-contact-with-consent-and-preferences)", "44-1": "Creates a contact with their consent and preference information", "48-0": "[Update contact with consent and preferences](doc:update-contact-with-consent-and-preferences)", "48-1": "Updates a contact by ID with their consent and preference information", "73-0": "[Resubscribe contact with no challenge](doc:resubscribe-contact-with-no-challenge)", "73-1": "Resubscribes a previously unsubscribed contact without sending a challenge email", "75-0": "[Resubscribe contact to address book with no challenge](doc:resubscribe-contact-to-address-book-with-no-challenge)", "75-1": "Resubscribes a previously unsubscribed contact to a given address book without sending a challenge email", "81-0": "[Get contact by ID with consent](doc:get-contact-by-id-with-consent)", "81-1": "Gets a contact by ID with their consent information", "82-1": "Gets a contact by email with their consent information", "82-0": "[Get contact by email with consent](doc:get-contact-by-email-with-consent)", "83-0": "[Get contacts opted into a preference and an address book](doc:get-contacts-opted-into-a-preference-and-an-address-book)", "83-1": "Gets contacts who are opted into a given preference and a given address book", "84-0": "[Get contacts opted into a preference](doc:get-contacts-opted-into-a-preference)", "84-1": "Gets contacts who are opted into a given preference", "85-0": "[Get contacts with modified preference opt-in since date](doc:get-contacts-with-modified-preference-opt-in-since-date)", "85-1": "Gets contacts who have had their specified preference opt-in status modified since a given date", "86-0": "[Get contacts with modified preference opt-in in address book since date](doc:get-contacts-with-modified-preference-opt-in-in-address-book-since-date)", "86-1": "Gets contacts who have had a specific preference opt-in status modified since a given date, in a given address book", "55-0": "[Get all contacts count](doc:get-all-contacts-count)", "55-1": "Gets the total number of contacts in the account", "137-0": "[Get account scoped transactional data](doc:get-account-scoped-transactional-data)", "137-1": "Gets transactional data in a collection at account level" }, "cols": 2, "rows": 141 } [/block]