Update a marketing email.
PATCH {{baseUrl}}/marketing/v3/emails/:emailId?archived=<boolean>
Change properties of a marketing email.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
archived | string | Whether to return only results that have been archived. |
Request Body
{"content"=>{"templatePath"=>"<string>", "plainTextVersion"=>"<string>"}, "from"=>{"fromName"=>"<string>", "replyTo"=>"<string>", "customReplyTo"=>"<string>"}, "id"=>"<string>", "name"=>"<string>", "sendOnPublish"=>"<boolean>", "state"=>"RSS_TO_EMAIL_DRAFT", "subcategory"=>"<string>", "subject"=>"<string>", "to"=>{"contactLists"=>{"include"=>["<long>", "<long>"], "exclude"=>["<long>", "<long>"]}, "contactIds"=>{"include"=>["<long>", "<long>"], "exclude"=>["<long>", "<long>"]}, "limitSendFrequency"=>"<boolean>", "suppressGraymail"=>"<boolean>"}, "createdById"=>"<integer>", "type"=>"RESUBSCRIBE_EMAIL", "activeDomain"=>"<string>", "archived"=>"<boolean>", "folderId"=>"<long>", "feedbackSurveyId"=>"<integer>", "stats"=>{"counters"=>{"occaecat_35"=>"<long>", "esse_dae"=>"<long>", "aliquip_9b"=>"<long>"}, "deviceBreakdown"=>{"ad_9"=>{"ea586"=>"<long>", "amet_cce"=>"<long>"}, "exercitation_2f"=>{"ut_2"=>"<long>", "eiusmod_d1"=>"<long>"}}, "qualifierStats"=>{"Duis_4"=>{"qui_e3"=>"<long>", "laborisf"=>"<long>"}, "Ut_2"=>{"doloref"=>"<long>"}, "sunt_3"=>{"qui045"=>"<long>", "nostrud1"=>"<long>"}}, "ratios"=>{"eiusmode34"=>"<number>", "fugiat_41"=>"<number>"}}, "testing"=>{"testId"=>"<long>", "hoursToWait"=>"<integer>", "abSuccessMetric"=>"OPENS_BY_DELIVERED", "abSampleSizeDefault"=>"variant", "abStatus"=>"automated_master", "abTestPercentage"=>"<integer>", "abSamplingDefault"=>"master"}, "subscriptionDetails"=>{"subscriptionId"=>"<long>", "preferencesGroupId"=>"<long>", "officeLocationId"=>"<string>"}, "updatedById"=>"<integer>", "publishedById"=>"<integer>", "language"=>"bo-in", "campaign"=>"<string>", "webversion"=>{"slug"=>"<string>", "domain"=>"<string>", "title"=>"<string>", "metaDescription"=>"<string>", "redirectToUrl"=>"<string>", "redirectToPageId"=>"<long>", "expiresAt"=>"<dateTime>"}, "rssData"=>{"maxEntries"=>"<integer>", "url"=>"<string>", "hubspotBlogId"=>"<long>", "blogEmailType"=>"<string>", "blogImageMaxWidth"=>"<integer>", "rssEntryTemplate"=>"<string>", "useHeadlineAsSubject"=>"<boolean>", "blogLayout"=>"<string>"}, "isTransactional"=>"<boolean>", "isPublished"=>"<boolean>", "publishDate"=>"<dateTime>", "updatedAt"=>"<dateTime>", "createdAt"=>"<dateTime>", "deletedAt"=>"<dateTime>", "publishedAt"=>"<dateTime>"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
{"content":{"templatePath":"\u003cstring\u003e","plainTextVersion":"\u003cstring\u003e","widgets":{"Excepteur_8":{},"in15":{},"tempor_0":{}},"widgetContainers":{"fugiat_f8":{},"labore9":{},"in74c":{}},"flexAreas":{"commodoed3":{},"laborea8":{},"ut_5":{}},"styleSettings":{},"smartFields":{"culpaf3":{},"proident2f":{}},"themeSettingsValues":{"commodo2aa":{}}},"from":{"fromName":"\u003cstring\u003e","replyTo":"\u003cstring\u003e","customReplyTo":"\u003cstring\u003e"},"id":"\u003cstring\u003e","name":"\u003cstring\u003e","sendOnPublish":"\u003cboolean\u003e","state":"RSS_TO_EMAIL_DRAFT","subcategory":"\u003cstring\u003e","subject":"\u003cstring\u003e","to":{"contactLists":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"contactIds":{"include":["\u003clong\u003e","\u003clong\u003e"],"exclude":["\u003clong\u003e","\u003clong\u003e"]},"limitSendFrequency":"\u003cboolean\u003e","suppressGraymail":"\u003cboolean\u003e"},"createdById":"\u003cinteger\u003e","type":"RESUBSCRIBE_EMAIL","activeDomain":"\u003cstring\u003e","archived":"\u003cboolean\u003e","folderId":"\u003clong\u003e","feedbackSurveyId":"\u003cinteger\u003e","stats":{"counters":{"occaecat_35":"\u003clong\u003e","esse_dae":"\u003clong\u003e","aliquip_9b":"\u003clong\u003e"},"deviceBreakdown":{"ad_9":{"ea586":"\u003clong\u003e","amet_cce":"\u003clong\u003e"},"exercitation_2f":{"ut_2":"\u003clong\u003e","eiusmod_d1":"\u003clong\u003e"}},"qualifierStats":{"Duis_4":{"qui_e3":"\u003clong\u003e","laborisf":"\u003clong\u003e"},"Ut_2":{"doloref":"\u003clong\u003e"},"sunt_3":{"qui045":"\u003clong\u003e","nostrud1":"\u003clong\u003e"}},"ratios":{"eiusmode34":"\u003cnumber\u003e","fugiat_41":"\u003cnumber\u003e"}},"testing":{"testId":"\u003clong\u003e","hoursToWait":"\u003cinteger\u003e","abSuccessMetric":"OPENS_BY_DELIVERED","abSampleSizeDefault":"variant","abStatus":"automated_master","abTestPercentage":"\u003cinteger\u003e","abSamplingDefault":"master"},"subscriptionDetails":{"subscriptionId":"\u003clong\u003e","preferencesGroupId":"\u003clong\u003e","officeLocationId":"\u003cstring\u003e"},"updatedById":"\u003cinteger\u003e","publishedById":"\u003cinteger\u003e","language":"bo-in","campaign":"\u003cstring\u003e","webversion":{"slug":"\u003cstring\u003e","domain":"\u003cstring\u003e","title":"\u003cstring\u003e","metaDescription":"\u003cstring\u003e","redirectToUrl":"\u003cstring\u003e","redirectToPageId":"\u003clong\u003e","expiresAt":"\u003cdateTime\u003e"},"rssData":{"maxEntries":"\u003cinteger\u003e","timing":{"laborisfe_":{},"ipsum2":{}},"url":"\u003cstring\u003e","hubspotBlogId":"\u003clong\u003e","blogEmailType":"\u003cstring\u003e","blogImageMaxWidth":"\u003cinteger\u003e","rssEntryTemplate":"\u003cstring\u003e","useHeadlineAsSubject":"\u003cboolean\u003e","blogLayout":"\u003cstring\u003e"},"isTransactional":"\u003cboolean\u003e","isPublished":"\u003cboolean\u003e","publishDate":"\u003cdateTime\u003e","updatedAt":"\u003cdateTime\u003e","createdAt":"\u003cdateTime\u003e","deletedAt":"\u003cdateTime\u003e","publishedAt":"\u003cdateTime\u003e"}