PUT /_system/entity/domains
Update an existing entity domain (requires setting_manage_domains permission)
Update an existing entity domain (requires setting_manage_domains permission)
| Key | Type | Example | Description |
|---|---|---|---|
| authorizationrequired | string | | Access token |
| Key | Type | Example | Description |
|---|---|---|---|
| nameoptional | string | | New domain name |
| originalnameoptional | string | | Current domain name |
| template_loginoptional | string | | |
| template_passwordresetoptional | string | | |
| template_passwordreset_emailoptional | string | | |
| template_securityoptional | string | |
{
"message": "ok"
}{
"error": "ERROR"
}| Status | Error Code | Description |
|---|---|---|
400 | ERROR | Domain name already exists |
401 | INVALID_ACCESS_TOKEN | Authentication required or invalid token |
| Permission | Description |
|---|---|
Bearer token | Access token required via Authorization header, x-authtoken, x-token, query param, or cookie |
entity_update | Required scope: entity_update |
Back to Entity Management Return to the Entity Management category to view other endpoints All API Categories Browse all available API categories