---
title: "PUT (Update) An Email Campaign Activity"
method: PUT
path: "/emails/activities/{campaign_activity_id}"
tags: ["Email Campaigns"]
---

# PUT (Update) An Email Campaign Activity

`PUT /emails/activities/{campaign_activity_id}`

Use this method to update an email campaign activity by including the complete email campaign activity with your changes in the request body. The request body requires the `from_name`, `from_email`, `reply_to_email`, and `subject` properties.

You can only update email campaign activities that have the `primary_email` role and that are in `DRAFT` or `Done` status.
When you use a PUT method to update a resource, the V3 API overwrites any properties that are missing in the request body. However, the V3 API does not overwrite subresources that you omit in the request body or missing properties in subresources. This method considers `physical_address_in_footer`, `document_properties`, `html_content`, and `permalink_url` subresources of the email campaign activity.

## Path parameters

- `campaign_activity_id` string, required

## Request body

- EmailCampaignActivity
  - `campaign_activity_id` string — Identifies a campaign activity in the V3 API.
  - `campaign_id` string — Identifies a campaign in the V3 API.
  - `role` string — The purpose of the individual campaign activity in the larger email campaign effort. Valid values are: <ul> <li>primary_email — The main email marketing campaign that you send to contacts. The <code>primary_email</code> contains the complete email content.</li> <li>permalink — A permanent link to a web accessible version of the <code>primary_email</code> content without any personalized email information. For example, permalinks do not contain any of the contact details that you add to the <code>primary_email</code> email content. </li> <li>resend — An email campaign that you resend to contacts that did not open the email campaign.</li> </ul> Constant Contact creates a <code>primary_email</code> and a <code>permalink</code> role campaign activity when you create an email campaign.
  - `contact_list_ids` string[] — The contacts that Constant Contact sends the email campaign activity to as an array of contact <code>list_id</code> values. You cannot use contact lists and segments at the same time in an email campaign activity.
  - `segment_ids` integer[] — The contacts that Constant Contact sends the email campaign activity to as an array containing a single <code>segment_id</code> value. Only <code>format_type</code> 3, 4, and 5 email campaign activities support segments. You cannot use contact lists and segments at the same time in an email campaign activity.
  - `current_status` string — The current status of the email campaign activity. Valid values are: <ul> <li>DRAFT — An email campaign activity that you have created but have not sent to contacts.</li> <li>SCHEDULED — An email campaign activity that you have scheduled for Constant Contact to send to contacts.</li> <li>EXECUTING — An email campaign activity Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>DONE — An email campaign activity that you successfully sent to contacts.</li> <li>ERROR — An email campaign activity that encountered an error.</li> <li>REMOVED — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
  - `format_type` integer — Identifies the type of email format. Valid values are: <ul> <li>1 - A legacy custom code email created using the V2 API, the V3 API, or the legacy UI HTML editor.</li> <li>2 - An email created using the second generation email editor UI.</li> <li>3 - An email created using the third generation email editor UI. This email editor features an improved drag and drop UI and mobile responsiveness.</li> <li>4 - An email created using the fourth generation email editor UI.</li> <li>5 - A custom code email created using the V3 API or the new UI HTML editor.</li> </ul>
  - `from_email` string, required — The email "From Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
  - `from_name` string, required — The email "From Name" field for the email campaign activity.
  - `reply_to_email` string, required — The email "Reply To Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
  - `subject` string, required — The email "Subject" field for the email campaign activity.
  - `html_content` string — The HTML or XHTML content for the email campaign activity. Only <code>format_type</code> 1 and 5 (legacy custom code emails or modern custom code emails) can contain <code>html_content</code>.
  - `permalink_url` string — The permanent link to a web accessible version of the email campaign content without any personalized email information. The permalink URL becomes accessible after you send an email campaign to contacts.
  - `preheader` string — The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.
  - `physical_address_in_footer` EmailPhysicalAddress
    - `address_line1` string, required — Line 1 of the organization's street address.
    - `address_line2` string — Line 2 of the organization's street address.
    - `address_line3` string — Line 3 of the organization's street address.
    - `address_optional` string — An optional address field for the organization. Only <code>format_type</code> 3, 4, and 5 can use this property.
    - `city` string — The city where the organization sending the email campaign is located.
    - `country_code` string, required — The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.
    - `country_name` string — The full name of the country where the organization sending the email is located. Automatically generated using the <code>country_code</code>.
    - `organization_name` string, required — The name of the organization that is sending the email campaign.
    - `postal_code` string — The postal code address (ZIP code) of the organization.
    - `state_code` string — The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's state. This property is required if the <code>country_code</code> is US (United States).
    - `state_name` string — The full state name for a <code>state_code</code> that is inside the United States. Automatically generated using the <code>state_code</code>.
    - `state_non_us_name` string — The full state name for a <code>state_code</code> that is outside the United States. This property is not read only.
  - `document_id` string — Identifies the email document used in an email editor (format_type 4) email campaign.
  - `document_properties` object — An object that contains optional properties for legacy format type emails (<code>format_type</code> 1 and 2). If you attempt to add a property that does apply to the email <code>format_type</code>, the API will ignore the property.
    - `style_content` string — Contains style sheet elements for XHTML letter format emails. This property applies only to <code>format_type</code> 1.
    - `letter_format` string — Email message format. Valid values are <code>HTML</code> and <code>XHTML</code>. By default, the value is <code>HTML</code>. For more information, see the <a href="http://www.constantcontact.com/display_media.jsp?id=87" target="_blank">Advanced Editor User's Guide</a>. This property applies only to <code>format_type</code> 1. You cannot change this property after you create an email.
    - `greeting_salutation` string — The greeting used in the email message. This property applies only to <code>format_type</code> 1.
    - `greeting_name_type` string — The type of name the campaign uses to greet the contact. Valid values are <code>F</code> (First Name), <code>L</code> (Last Name), <code>B</code> (First and Last Name), or <code>N</code> (No greeting). By default, the value is <code>N</code>. This property applies only to <code>format_type</code> 1.
    - `greeting_secondary` string — A fallback text string the campaign uses to greet the contact when the <code>greeting_name_type</code> is not available or set to <code>N</code>. This property applies only to <code>format_type</code> 1.
    - `subscribe_link_enabled` string — If <code>true</code>, the email footer includes a link for subscribing to the list. If <code>false</code>, the message footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies only to <code>format_type</code> 1.
    - `subscribe_link_name` string — The text displayed as the name for the subscribe link in the email footer. This property applies only to <code>format_type</code> 1.
    - `text_content` string — Contains the text content that Constant Contact displays to contacts when their email client cannot display HTML email. If you do not specify text content, Constant Contact displays "Greetings!" as the text content. This property applies only to <code>format_type</code> 1.
    - `permission_reminder_enabled` string — If <code>true</code>, Constant Contact displays your <code>permission_reminder</code> message to contacts at top of the email. If <code>false</code>, Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `permission_reminder` string — The message text Constant Contact displays at the top of the email message to remind users that they are subscribed to an email list. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_enabled` string — If <code>true</code>, Constant Contact displays the view as web page email message. If <code>false</code> Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_text` string — The text Constant Contact displays before the view as web page link at the top of the email. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_link_name` string — The name of the link that users can click to view the email as a web page. This property applies to <code>format_type</code> 1 and 2.
    - `forward_email_link_enabled` string — If <code>true</code>, when the user forwards an email message the footer includes a link for subscribing to the list. If <code>false</code>, when a user forwards an email message the footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `forward_email_link_name` string — The text displayed as the name for the forward email link in the footer when a user forwards an email. This property applies to <code>format_type</code> 1 and 2.

## Response `200`

Email campaign activity successfully updated.

- EmailCampaignActivity
  - `campaign_activity_id` string — Identifies a campaign activity in the V3 API.
  - `campaign_id` string — Identifies a campaign in the V3 API.
  - `role` string — The purpose of the individual campaign activity in the larger email campaign effort. Valid values are: <ul> <li>primary_email — The main email marketing campaign that you send to contacts. The <code>primary_email</code> contains the complete email content.</li> <li>permalink — A permanent link to a web accessible version of the <code>primary_email</code> content without any personalized email information. For example, permalinks do not contain any of the contact details that you add to the <code>primary_email</code> email content. </li> <li>resend — An email campaign that you resend to contacts that did not open the email campaign.</li> </ul> Constant Contact creates a <code>primary_email</code> and a <code>permalink</code> role campaign activity when you create an email campaign.
  - `contact_list_ids` string[] — The contacts that Constant Contact sends the email campaign activity to as an array of contact <code>list_id</code> values. You cannot use contact lists and segments at the same time in an email campaign activity.
  - `segment_ids` integer[] — The contacts that Constant Contact sends the email campaign activity to as an array containing a single <code>segment_id</code> value. Only <code>format_type</code> 3, 4, and 5 email campaign activities support segments. You cannot use contact lists and segments at the same time in an email campaign activity.
  - `current_status` string — The current status of the email campaign activity. Valid values are: <ul> <li>DRAFT — An email campaign activity that you have created but have not sent to contacts.</li> <li>SCHEDULED — An email campaign activity that you have scheduled for Constant Contact to send to contacts.</li> <li>EXECUTING — An email campaign activity Constant Contact is currently sending to contacts. Email campaign activities are only in this status briefly.</li> <li>DONE — An email campaign activity that you successfully sent to contacts.</li> <li>ERROR — An email campaign activity that encountered an error.</li> <li>REMOVED — An email campaign that a user deleted. Users can view and restore deleted emails through the UI.</li> </ul>
  - `format_type` integer — Identifies the type of email format. Valid values are: <ul> <li>1 - A legacy custom code email created using the V2 API, the V3 API, or the legacy UI HTML editor.</li> <li>2 - An email created using the second generation email editor UI.</li> <li>3 - An email created using the third generation email editor UI. This email editor features an improved drag and drop UI and mobile responsiveness.</li> <li>4 - An email created using the fourth generation email editor UI.</li> <li>5 - A custom code email created using the V3 API or the new UI HTML editor.</li> </ul>
  - `from_email` string, required — The email "From Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
  - `from_name` string, required — The email "From Name" field for the email campaign activity.
  - `reply_to_email` string, required — The email "Reply To Email" field for the email campaign activity. You must use a confirmed Constant Contact account email address. Make a GET call to <code>/account/emails</code> to return a collection of account emails and their confirmation status.
  - `subject` string, required — The email "Subject" field for the email campaign activity.
  - `html_content` string — The HTML or XHTML content for the email campaign activity. Only <code>format_type</code> 1 and 5 (legacy custom code emails or modern custom code emails) can contain <code>html_content</code>.
  - `permalink_url` string — The permanent link to a web accessible version of the email campaign content without any personalized email information. The permalink URL becomes accessible after you send an email campaign to contacts.
  - `preheader` string — The email preheader for the email campaign activity. Only <code>format_type</code> 3, 4, and 5 email campaign activities use the preheader property.
  - `physical_address_in_footer` EmailPhysicalAddress
    - `address_line1` string, required — Line 1 of the organization's street address.
    - `address_line2` string — Line 2 of the organization's street address.
    - `address_line3` string — Line 3 of the organization's street address.
    - `address_optional` string — An optional address field for the organization. Only <code>format_type</code> 3, 4, and 5 can use this property.
    - `city` string — The city where the organization sending the email campaign is located.
    - `country_code` string, required — The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's country.
    - `country_name` string — The full name of the country where the organization sending the email is located. Automatically generated using the <code>country_code</code>.
    - `organization_name` string, required — The name of the organization that is sending the email campaign.
    - `postal_code` string — The postal code address (ZIP code) of the organization.
    - `state_code` string — The uppercase two letter <a href='https://en.wikipedia.org/wiki/ISO_3166-1' target='_blank'>ISO 3166-1 code</a> for the organization's state. This property is required if the <code>country_code</code> is US (United States).
    - `state_name` string — The full state name for a <code>state_code</code> that is inside the United States. Automatically generated using the <code>state_code</code>.
    - `state_non_us_name` string — The full state name for a <code>state_code</code> that is outside the United States. This property is not read only.
  - `document_id` string — Identifies the email document used in an email editor (format_type 4) email campaign.
  - `document_properties` object — An object that contains optional properties for legacy format type emails (<code>format_type</code> 1 and 2). If you attempt to add a property that does apply to the email <code>format_type</code>, the API will ignore the property.
    - `style_content` string — Contains style sheet elements for XHTML letter format emails. This property applies only to <code>format_type</code> 1.
    - `letter_format` string — Email message format. Valid values are <code>HTML</code> and <code>XHTML</code>. By default, the value is <code>HTML</code>. For more information, see the <a href="http://www.constantcontact.com/display_media.jsp?id=87" target="_blank">Advanced Editor User's Guide</a>. This property applies only to <code>format_type</code> 1. You cannot change this property after you create an email.
    - `greeting_salutation` string — The greeting used in the email message. This property applies only to <code>format_type</code> 1.
    - `greeting_name_type` string — The type of name the campaign uses to greet the contact. Valid values are <code>F</code> (First Name), <code>L</code> (Last Name), <code>B</code> (First and Last Name), or <code>N</code> (No greeting). By default, the value is <code>N</code>. This property applies only to <code>format_type</code> 1.
    - `greeting_secondary` string — A fallback text string the campaign uses to greet the contact when the <code>greeting_name_type</code> is not available or set to <code>N</code>. This property applies only to <code>format_type</code> 1.
    - `subscribe_link_enabled` string — If <code>true</code>, the email footer includes a link for subscribing to the list. If <code>false</code>, the message footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies only to <code>format_type</code> 1.
    - `subscribe_link_name` string — The text displayed as the name for the subscribe link in the email footer. This property applies only to <code>format_type</code> 1.
    - `text_content` string — Contains the text content that Constant Contact displays to contacts when their email client cannot display HTML email. If you do not specify text content, Constant Contact displays "Greetings!" as the text content. This property applies only to <code>format_type</code> 1.
    - `permission_reminder_enabled` string — If <code>true</code>, Constant Contact displays your <code>permission_reminder</code> message to contacts at top of the email. If <code>false</code>, Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `permission_reminder` string — The message text Constant Contact displays at the top of the email message to remind users that they are subscribed to an email list. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_enabled` string — If <code>true</code>, Constant Contact displays the view as web page email message. If <code>false</code> Constant Contact does not display the message. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_text` string — The text Constant Contact displays before the view as web page link at the top of the email. This property applies to <code>format_type</code> 1 and 2.
    - `view_as_webpage_link_name` string — The name of the link that users can click to view the email as a web page. This property applies to <code>format_type</code> 1 and 2.
    - `forward_email_link_enabled` string — If <code>true</code>, when the user forwards an email message the footer includes a link for subscribing to the list. If <code>false</code>, when a user forwards an email message the footer does not include a link for subscribing to the list. By default, the value is <code>false</code>. This property applies to <code>format_type</code> 1 and 2.
    - `forward_email_link_name` string — The text displayed as the name for the forward email link in the footer when a user forwards an email. This property applies to <code>format_type</code> 1 and 2.

## Other responses

- `400` — Bad request. Either the JSON was malformed or there was a data validation error.
- `401` — The Access Token used is invalid.
- `403` — Forbidden request. You lack the necessary scopes, you lack the necessary user privileges, or the application is deactivated.
- `404` — The requested resource was not found.
- `415` — Unsupported Media Type.
- `429` — Too many requests. You exceeded the request rate limit.
- `500` — There was a problem with our internal service.

---

[API](https://skmtc.net/cc/apis/appconnect-v3.md) · [All operations](https://skmtc.net/cc/apis/appconnect-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/cc/appconnect-v3/versions/4b4a534c818d/schema)