Update domain - Manage Domains - API Reference

PUT

https://api.us.nylas.com/v3/domains/{domain_id}

Renames a domain.

name is the only field you can change. To use a different address, register a new domain and delete the old one.

Requires an IAM API key with the domains.update permission. Application API keys and access tokens don't work.

Parameters

Path parameters

domain_id*string

The domain's ID or address.

Example: "0a2171c6-c298-4671-8b82-d832a7fd5170"

Request body

namestring

A human-readable label for the domain.

Example: "Transactional mail (US)"

Responses

OK. The response only includes the new name and updated_at.

request_idstring

ID of the request.

Example: "5fa64c92-e840-4357-86b9-2aa364d35b88"

dataobject

curl --request PUT \ --url "https://api.us.nylas.com/v3/domains/${DOMAIN_ID}" \ --header "Authorization: Bearer $NYLAS_DOMAINS_KEY" \ --header "Content-Type: application/json" \ --data '{ "name": "Transactional mail (US)" }'