Update Alias Status

The Update Alias Status endpoint enables you to update the status of an alias to active or disabled. A disabled alias will not be available for alias resolution.

You can update an alias' status by making a PUT request to the Update Alias Status endpoint, where aliasId is the identifier generated by Alias Directory. For example:

{{base-url}}/ads/api/v1/aliases/{aliasId}/status

The body should include the new status of the alias. The below example shows a request to make the alias active.

{
  "status": "ACTIVE"
}

If successful, a 204 response is returned.

📘

More Information

• To view this endpoint in the API Explorer, see Update Alias Status.
• To view descriptions for this endpoint, see Update Alias Status - Field Descriptions.