# Validate a branded link

## API Overview

Email link branding (formerly "Link Whitelabel") allows all of the click-tracked links, opens, and images in your emails to be served from your domain rather than `sendgrid.net` for Global Email send or `eu.sendgrid.net` for Regional Email send. Spam filters and recipient servers look at the links within emails to determine whether the email looks trustworthy. They use the reputation of the root domain to determine whether the links can be trusted.

You can also manage link branding in the [Sender Authentication section of the Twilio SendGrid App](https://app.sendgrid.com/settings/sender_auth).

For more information, please see our [Link Branding documentation](/docs/sendgrid/ui/account-and-settings/how-to-set-up-link-branding/).

## Operation overview

```json
{"path":"https://api.sendgrid.com/v3/whitelabel/links/{id}/validate","method":"post","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 validate a branded link.**

You can submit this request as one of your subusers if you include their ID in the `on-behalf-of` header in the request.

## 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"}]
```

### Path parameters

```json
[{"name":"id","in":"path","description":"The ID of the branded link that you want to validate.","required":true,"schema":{"type":"integer"}}]
```

### Responses

```json
[{"responseCode":"200","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","required":["id","valid","validation_results"],"properties":{"id":{"type":"integer","description":"The ID of the branded link."},"valid":{"type":"boolean","description":"Indicates if the link branding is valid.","enum":[true,false],"refName":"Valid","modelName":"Valid"},"validation_results":{"type":"object","description":"The individual validation results for each of the DNS records associated with this branded link.","required":["domain_cname"],"properties":{"domain_cname":{"type":"object","description":"The DNS record generated for the sending domain used for this branded link.","required":["valid","reason"],"properties":{"valid":{"type":"boolean","description":"Indicates if this DNS record is valid.","enum":[true,false],"refName":"Valid1","modelName":"Valid1"},"reason":{"type":"string","nullable":true,"description":"Null if the DNS record is valid. If the DNS record is invalid, this will explain why."}}},"owner_cname":{"type":"object","description":"The DNS record created to verify the branded link.","required":["valid","reason"],"properties":{"valid":{"type":"boolean","description":"Indicates if the DNS record is valid.","enum":[true,false],"refName":"Valid2","modelName":"Valid2"},"reason":{"type":"string","nullable":true,"description":"Null if valid. If the DNS record is invalid, this will explain why."}}}}}}},"examples":{"response":{"value":{"id":1,"valid":true,"validation_results":{"domain_cname":{"valid":false,"reason":"Expected CNAME to match \"sendgrid.net.\" but found \"example.com.\"."},"owner_cname":{"valid":true,"reason":null}}}}}}}}},{"responseCode":"500","schema":{"description":"","content":{"application/json":{"schema":{"type":"object","required":["errors"],"properties":{"errors":{"type":"array","description":"The reasons why the validation failed.","items":{"type":"object","required":["message"],"properties":{"message":{"type":"string","description":"The reason why the link whitelabel could not be validated."}}}}}},"examples":{"response":{"value":{"errors":[{"message":"internal error getting CNAME"}]}}}}}}}]
```

Validate a branded link

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

const id = 42;

const request = {
  url: `/v3/whitelabel/links/${id}/validate`,
  method: "POST",
};

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"))

id = 42

response = sg.client.whitelabel.links._(id).validate.post()

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 id = 42;

        var response = await client.RequestAsync(
            method: SendGridClient.Method.POST, urlPath: $"whitelabel/links/{id}/validate");

        Console.WriteLine(response.StatusCode);
        Console.WriteLine(response.Body.ReadAsStringAsync().Result);
        Console.WriteLine(response.Headers.ToString());
    }
}
```

```java
import com.sendgrid.*;
import java.io.IOException;

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.POST);
            request.setEndpoint("/whitelabel/links/42/validate");
            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/whitelabel/links/42/validate", host)
	request.Method = "POST"
	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);
$id = 42;

try {
    $response = $sg->client
        ->whitelabel()
        ->links()
        ->_($id)
        ->validate()
        ->post();
    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'])
id = 42

response = sg.client.whitelabel.links._(id).validate.post()
puts response.status_code
puts response.headers
puts response.body
```

```bash
curl -X POST "https://api.sendgrid.com/v3/whitelabel/links/42/validate" \
--header "Authorization: Bearer $SENDGRID_API_KEY"
```