# Update a Campaign ## API Overview > \[!WARNING] > > This covers the obsolete Legacy Marketing Campaigns API. > \[!NOTE] > > For the most up-to-date information on the Sender Identities API, please visit the [new Marketing Campaigns Single Sends API](/docs/sendgrid/api-reference/single-sends). The Campaigns API allows you to create and manage marketing campaigns. You can create campaigns, manage campaign content, and schedule campaigns to be sent at a later time. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/campaigns/{campaign_id}","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"The Twilio SendGrid v3 API"}]} ``` **This endpoint allows you to update a specific campaign.** This is especially useful if you only set up the campaign using POST /campaigns, but didn't set many of the parameters. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}},{"name":"on-behalf-of","in":"header","description":"The `on-behalf-of` header allows you to make API calls from a parent account on behalf of the parent's Subusers or customer accounts. You will use the parent account's API key when using this header. When making a call on behalf of a customer account, the property value should be \"account-id\" followed by the customer account's ID (e.g., `on-behalf-of: account-id `). When making a call on behalf of a Subuser, the property value should be the Subuser's username (e.g., `on-behalf-of: `). See [**On Behalf Of**](/docs/sendgrid/api-reference/how-to-use-the-sendgrid-v3-api/on-behalf-of) for more information.","required":false,"schema":{"type":"string"},"refName":"#/components/parameters/OnBehalfOf","modelName":"__components_parameters_OnBehalfOf"}] ``` ### Path parameters ```json [{"name":"campaign_id","in":"path","description":"The id of the campaign you would like to retrieve.","required":true,"schema":{"type":"integer"}}] ``` ### Request body ```json {"schema":{"title":"Update a Campaign request","type":"object","required":["title","subject","categories","html_content","plain_content"],"example":{"title":"May Newsletter","subject":"New Products for Summer!","categories":["summer line"],"html_content":"

Check out our summer line!

","plain_content":"Check out our summer line!"},"properties":{"title":{"type":"string","description":"The title of the campaign."},"subject":{"type":"string","description":"The subject line for your campaign."},"categories":{"type":"array","description":"The categories you want to tag on this campaign.","items":{"type":"string"}},"html_content":{"type":"string","description":"The HTML content of this campaign."},"plain_content":{"type":"string","description":"The plain content of this campaign."}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"Campaigns Response","type":"object","required":["status","title"],"refName":"Campaigns2xx","modelName":"Campaigns2xx","properties":{"title":{"type":"string","description":"The display title of your campaign. This will be viewable by you in the Marketing Campaigns UI."},"subject":{"description":"The subject of your campaign that your recipients will see.","nullable":true,"type":"string"},"sender_id":{"description":"The ID of the \"sender\" identity that you have created. Your recipients will see this as the \"from\" on your marketing emails.","nullable":true,"type":"integer"},"list_ids":{"description":"The IDs of the lists you are sending this campaign to. You can have both segment IDs and list IDs","nullable":true,"type":"array","items":{"type":"integer"}},"segment_ids":{"description":"The segment IDs that you are sending this list to. You can have both segment IDs and list IDs. Segments are limited to 10 segment IDs.","nullable":true,"type":"array","items":{"type":"integer"}},"categories":{"description":"The categories you would like associated to this campaign.","nullable":true,"type":"array","items":{"type":"string"}},"suppression_group_id":{"description":"The suppression group that this marketing email belongs to, allowing recipients to opt-out of emails of this type.","nullable":true,"type":"integer"},"custom_unsubscribe_url":{"description":"This is the url of the custom unsubscribe page that you provide for customers to unsubscribe from your suppression groups.","nullable":true,"type":"string"},"ip_pool":{"description":"The pool of IPs that you would like to send this email from.","nullable":true,"type":"string"},"html_content":{"description":"The HTML of your marketing email.","nullable":true,"type":"string"},"plain_content":{"description":"The plain text content of your emails.","nullable":true,"type":"string"},"editor":{"type":"string","description":"The editor used in the UI.","enum":["code","design"],"refName":"Editor","modelName":"Editor"},"status":{"type":"string","description":"The status of your campaign."},"id":{"type":"integer"}}},"examples":{"response":{"value":{"id":986724,"title":"May Newsletter","subject":"New Products for Summer!","sender_id":124451,"list_ids":[110,124],"segment_ids":[110],"categories":["summer line"],"suppression_group_id":42,"custom_unsubscribe_url":"","ip_pool":"marketing","html_content":"

Check out our summer line!

","plain_content":"Check out our summer line!","status":"Draft"}}}}}}},{"responseCode":"400","schema":{"description":"The request was formatted incorrectly or missing required parameters.","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}},"examples":{"response":{"value":{"errors":[{"field":"title","message":"title can't be blank"},{"field":"title","message":"title is too long (maximum is 100 characters)"},{"field":"categories","message":"categories exceeds 10 category limit"},{"field":"html_content","message":"html_content exceeds the 1MB limit"},{"field":"plain_content","message":"plain_content exceeds the 1MB limit"},{"field":"sender_id","message":"sender_id does not exist"},{"field":"sender_id","message":"sender_id is not a verified sender identity"},{"field":"list_ids","message":"list_ids do not all exist"},{"field":"segment_ids","message":"segment_ids do not all exist"},{"field":"ip_pool","message":"The ip pool you provided is invalid"},{"field":"suppression_group_id","message":"suppression_group_id does not exist"},{"field":"unsubscribes","message":"Either suppression_group_id or custom_unsubscribe_url may be set/used, but not both. Please remove one before setting the other."},{"field":null,"message":"The JSON you have submitted cannot be parsed."}]}}}}}}},{"responseCode":"401","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}},"examples":{"response":{"value":{"errors":[{"field":null,"message":"authorization required"}]}}}}}}},{"responseCode":"403","schema":{"description":"You may only update a campaign when it is in draft mode.","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}},"examples":{"response":{"value":{"errors":[{"field":null,"message":"You may only update a campaign when it is in draft mode."}]}}}}}}},{"responseCode":"404","schema":{"description":"Not found","content":{"application/json":{"schema":{"type":"object","example":{"errors":[{"field":"field_name","message":"error message"}]},"refName":"ErrorResponse","modelName":"ErrorResponse","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"message":{"type":"string","description":"An error message."},"field":{"description":"When applicable, this property value will be the field that generated the error.","nullable":true,"type":"string"},"help":{"type":"object","description":"When applicable, this property value will be helper text or a link to documentation to help you troubleshoot the error."}}}},"id":{"type":"string","description":"When applicable, this property value will be an error ID."}}},"examples":{"response":{"value":{"errors":[{"field":null,"message":"not found"}]}}}}}}}] ``` Update a Campaign ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const campaign_id = 42; const data = { title: "May Newsletter", subject: "New Products for Summer!", categories: ["summer line"], html_content: "

Check out our summer line!

", plain_content: "Check out our summer line!", }; const request = { url: `/v3/campaigns/${campaign_id}`, method: "PATCH", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) campaign_id = 42 data = { "title": "May Newsletter", "subject": "New Products for Summer!", "categories": ["summer line"], "html_content": "

Check out our summer line!

", "plain_content": "Check out our summer line!", } response = sg.client.campaigns._(campaign_id).patch(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var campaignId = 42; var data = @"{ ""title"": ""May Newsletter"", ""subject"": ""New Products for Summer!"", ""categories"": [ ""summer line"" ], ""html_content"": ""

Check out our summer line!

"", ""plain_content"": ""Check out our summer line!"" }"; var response = await client.RequestAsync( method: SendGridClient.Method.PATCH, urlPath: $"campaigns/{campaignId}", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; import java.util.Arrays; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PATCH); request.setEndpoint("/campaigns/42"); request.setBody(new JSONObject(new HashMap() { { put("title", "May Newsletter"); put("subject", "New Products for Summer!"); put("categories", Arrays.asList("summer line")); put("html_content", "

Check out our summer line!

"); put("plain_content", "Check out our summer line!"); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/campaigns/42", host) request.Method = "PATCH" request.Body = []byte(`{ "title": "May Newsletter", "subject": "New Products for Summer!", "categories": [ "summer line" ], "html_content": "

Check out our summer line!

", "plain_content": "Check out our summer line!" }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "title": "May Newsletter", "subject": "New Products for Summer!", "categories": [ "summer line" ], "html_content": "

Check out our summer line!

", "plain_content": "Check out our summer line!" }'); $campaign_id = 42; try { $response = $sg->client ->campaigns() ->_($campaign_id) ->patch($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) campaign_id = 42 data = JSON.parse('{ "title": "May Newsletter", "subject": "New Products for Summer!", "categories": [ "summer line" ], "html_content": "

Check out our summer line!

", "plain_content": "Check out our summer line!" }') response = sg.client.campaigns._(campaign_id).patch(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PATCH "https://api.sendgrid.com/v3/campaigns/42" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"title": "May Newsletter", "subject": "New Products for Summer!", "categories": ["summer line"], "html_content": "

Check out our summer line!

", "plain_content": "Check out our summer line!"}' ```