NYnylas
Manage Domains

Update domain

Changed on
<div id="admonition-warning">⚠️ <b>Before you can use the Manage Domains endpoints, you need a <a href="/docs/v3/auth/nylas-service-account/">Nylas Service Account</a></b>.</div>

Updates the specified domain. Currently, only the name field can be updated.

put/v3/admin/domains/{domain_id}

Request

  • Base URL
    https://api.us.nylas.com
  • Auth
    • HTTP bearer
    • or HTTP bearer

Request body

namestring

A human-readable label for the domain.

Example request

{
  "name": "Updated domain name"
}

Response

OK

request_idstring

ID of the request.

Example response

{
  "request_id": "5fa64c92-e840-4357-86b9-2aa364d35b88",
  "data": {
    "id": "abc-123-domain-id",
    "name": "My transactional domain",
    "domain_address": "mail.example.com",
    "organization_id": "org-123",
    "region": "us",
    "verified_ownership": true,
    "created_at": 1742932766,
    "updated_at": 1742932766
  }
}

Changes