# Update Subscription Tracking Settings

## API Overview

You can track many of your recipients' interactions with your emails, including:

* Opening emails
* Clicking links
* Subscribing to (or unsubscribing from) your emails

For more information about tracking, please see our [Tracking Settings documentation](/docs/sendgrid/ui/account-and-settings/tracking/).

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/tracking_settings/subscription","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]}
```

**This endpoint allows you to update your current settings for subscription tracking.**

Subscription tracking adds links to the bottom of your emails that allows your recipients to subscribe to, or unsubscribe from, your emails.

## Operation details

### Authentication

API Key

### Headers

```json
[{"in":"header","name":"Authorization","required":true,"default":"Bearer <<YOUR_API_KEY_HERE>>","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 <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: <subuser-username>`). 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"}]
```

### Request body

```json
{"schema":{"title":"Settings: Subscription Tracking","type":"object","refName":"SubscriptionTrackingSettings","modelName":"SubscriptionTrackingSettings","properties":{"enabled":{"type":"boolean","description":"Indicates if subscription tracking is enabled."},"html_content":{"type":"string","description":"The information and HTML for your unsubscribe link. "},"landing":{"type":"string","description":"The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server."},"plain_content":{"type":"string","description":"The information in plain text for your unsubscribe link. You should have the “<% %>” tag in your content, otherwise the user will have no URL for unsubscribing."},"replace":{"type":"string","description":"Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate."},"url":{"type":"string","description":"The URL where you would like your users sent to unsubscribe.","format":"uri"}}},"encodingType":"application/json"}
```

### Responses

```json
[{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"title":"Settings: Subscription Tracking","type":"object","refName":"SubscriptionTrackingSettings","modelName":"SubscriptionTrackingSettings","properties":{"enabled":{"type":"boolean","description":"Indicates if subscription tracking is enabled."},"html_content":{"type":"string","description":"The information and HTML for your unsubscribe link. "},"landing":{"type":"string","description":"The HTML that will be displayed on the page that your customers will see after clicking unsubscribe, hosted on SendGrid’s server."},"plain_content":{"type":"string","description":"The information in plain text for your unsubscribe link. You should have the “<% %>” tag in your content, otherwise the user will have no URL for unsubscribing."},"replace":{"type":"string","description":"Your custom defined replacement tag for your templates. Use this tag to place your unsubscribe content anywhere in your emailtemplate."},"url":{"type":"string","description":"The URL where you would like your users sent to unsubscribe.","format":"uri"}}},"examples":{"response":{"value":{"enabled":true,"landing":"landing page html","url":"http://mydomain.com/parse","replace":"replacement tag","html_content":"html content","plain_content":"text content"}}}}}}}]
```

Update Subscription Tracking Settings

```js
const client = require("@sendgrid/client");
client.setApiKey(process.env.SENDGRID_API_KEY);

const data = {
  enabled: false,
};

const request = {
  url: `/v3/tracking_settings/subscription`,
  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"))

data = {"enabled": False}

response = sg.client.tracking_settings.subscription.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 data =
            @"{
            ""enabled"": false
        }";

        var response = await client.RequestAsync(
            method: SendGridClient.Method.PATCH,
            urlPath: "tracking_settings/subscription",
            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;

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("/tracking_settings/subscription");
            request.setBody(new JSONObject(new HashMap<String, Object>() {
                {
                    put("enabled", false);
                }
            }).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/tracking_settings/subscription", host)
	request.Method = "PATCH"
	request.Body = []byte(`{
  "enabled": false
}`)
	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
<?php
// Uncomment the next line if you're using a dependency loader (such as Composer) (recommended)
// require 'vendor/autoload.php';

// Uncomment next line if you're not using a dependency loader (such as Composer)
// require_once '<PATH TO>/sendgrid-php.php';

$apiKey = getenv("SENDGRID_API_KEY");
$sg = new \SendGrid($apiKey);
$request_body = json_decode('{
    "enabled": false
}');

try {
    $response = $sg->client
        ->tracking_settings()
        ->subscription()
        ->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'])
data = JSON.parse('{
  "enabled": false
}')

response = sg.client.tracking_settings.subscription.patch(request_body: data)
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -X PATCH "https://api.sendgrid.com/v3/tracking_settings/subscription" \
--header "Authorization: Bearer $SENDGRID_API_KEY" \
--header "Content-Type: application/json" \
--data '{"enabled": false}'
```