---
id: scope-domain-update
title: "Update a custom domain"
description: "Updates a custom domain assigned to a scope."
sidebar_label: "Update a custom domain"
hide_title: true
hide_table_of_contents: true
api: eJzdWG1v2zYQ/isEP62A7MiOswYC8iFNOzT70BWJgxVLjeBMni22EqmSVFLX8H8fjpRs+aWrC7QbsCCQKep4fO65F74suUQnrKq8Mppn/K6S4NExYKJ23pRMmhKUZuCcmmuUzBsGzAlTYZ8n3FRogYZeS57x0P0QR2R10MQT7mHueHbPr7oK+SThDkVtlV/w7H7JpwgW7WXtc57dT1aThFdgoUSP1gUBDSXyjCvJE64IagU+5wm3+KlWFiXPvK0x2bFnnCOrtfpUI7t+yWbGMp/jtm1khxM5lsCzJfeLiqZx3io956uE42coq4L68Pk5pHI46J2K0Xnv+Wg46J0PhOwN09MZno+m5zh6zgk5QULnXxi5IJXCaI/aUxOqqlAiMHbywRHC5f7cZvoBhd8y7T6aT6xY4twrdDQikrKL+hAJJMnMbN988mj0FRGxsRYq1Rd2UXnTU1r0hSmJDefB12HqjqTw6jF4+pso4vAWxzqMUNclGVmhlkrPH6CqrHmEgifrrtyYj53XVuJBolYoN194woVF8LFpsfOyxhnMjX1tszulxAJ9a0GBPqifgSpCw3lTVfFraIZOAVpgQQKThHvlAy+3ZN5tJGwV/giQq4x20XvDdEQ/+zSt04o9gWOuFgKdm9UFcfVDoilkUQiexmt7kaXkcXHVwdB7UvKobPvelEp+RJwfE91R/THTkEQ7zSH9IbRDwmCBwht7yCMH8qOR/jp3214ydg5afQn0Pxzrsu4gdv1yG/gg0G31care3LwhFlB75RfbirqzXAwyEMLU2l8MM/KQq0DgxWnWiZ6LUaArLCHHWhKkKdR8Dn6fL8eUo5XLCAUeJXtSPu/vmDs8HfGQmZvK9r1lrOP/po6tK01blCbJfr1cNZUK5QP44+a9vv2jd/5rOmB34yvmVYnOQ1kRjqcc9YHaTuWjmYTwzYwtaS5O5b5HCrbIGKbDs1466KXDcZpm4f8vghmXh58MswDnm4XoeKzDHayrTfUNsfEy6L9pii6PNXj07t1+2b0qFGrP0Fpj2bpKM1kjLZBKP0KhJFO6qj0zlpXKOaXnbLNJ+WG1OQbXlZHBYMLDE16iczA/UKc70hu9Snuco91zzuvx+G0bvMJIZBYri47SV8/jklyhUDMlmOjy8Qv25/2EjdKUHgN6nNJj9Gwrm0ZpSkG9jeUrcXLJShC50tizCBKmBTZzBVwhnwV4nBurvqCL2NA+omW0Etd2Z7cyBfnQbLvCpi3QdgSIqVU4S1hel6A3SDpSbZJHcKHsN2y85y9Asps46XtOHXcaap8HyPI93yanK00QW49+G6SUippQMIkeVOEYTE3tN7C256EMbKgIiVVCQbmEkgV2tQdFG/k2pLsR3O5Szg5lyG2kfzdDlJYhzvWcgWbKuRqZiUl++faaOSXxf5YarktEEwxnlBpn6ZAep9uOP/vvsoKMtRqKhyj0ECn71/LjupmeNaHzimRiplCPEsjuNDyCKkjrXsIcHP5TU+dSs1rj5woFbReiSUaI2lqUffa2QHDIvF0wmNOyVYBH22ZNwOVzI+PRVNDZNBxRM37SPRifLJVc0eEhGBXPtrUteMZz7yuXnZzQ3lTXRVEV4Clz4+60c2C+pWSJMd49Nq/ZIEXtoTYUxyDEk6bxW7uy/v7nOCyZlIQ3mzPrq5aP9aH7wG55s2Hq7GeUnhkaRoZFDwz6aT/lm1X5Tccuqg80qjLOl6A788VbiN1LiF33dk7W33tv0RDl8bM/qQrSTdsc8sKycdr91m0GT3imwuEuN87T1+VyCg7vbLFaUfenGi1dZEwS/ghWUTwHz0rlqC15NoPC7V5PdC345aYpdM/YkZcWB41oOkEvOEEpanrjCf+Ii3h7spqsEp4jSLQBYfxwFXH0xjR8M3CvVK+SdsSlEFj5f5SddFLi7eX46jWFYHMpUoZ6yC08UY2Hp4jSBGJCZIe+JS9Az+uQ7DwqpYCF7Xjfie9g1kEelssoMTYfUa9Wa1o8vRMzq9Xf/iGHcA==
sidebar_class_name: "patch api-method"
info_path: docs/api/nullplatform-api
custom_edit_url: null
---

import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
import ParamsDetails from "@theme/ParamsDetails";
import RequestSchema from "@theme/RequestSchema";
import StatusCodes from "@theme/StatusCodes";
import OperationTabs from "@theme/OperationTabs";
import TabItem from "@theme/TabItem";
import Heading from "@theme/Heading";

<Heading
  as={"h1"}
  className={"openapi__heading"}
  children={"Update a custom domain"}
>
</Heading>

<MethodEndpoint
  method={"patch"}
  path={"/scope_domain/{id}"}
  context={"endpoint"}
>
  
</MethodEndpoint>



Updates a custom domain assigned to a scope.

<Heading
  id={"request"}
  as={"h2"}
  className={"openapi-tabs__heading"}
  children={"Request"}
>
</Heading>

<ParamsDetails
  parameters={[{"name":"id","in":"path","required":true,"description":"The unique ID for the custom domain.","schema":{"type":"string"},"example":"e78a0d21-3c48-7421-81cd-203fe84b8e47"}]}
>
  
</ParamsDetails>

<RequestSchema
  title={"Body"}
  body={{"content":{"application/json":{"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name of the custom domain to update.","example":"api.crypto-inc.com"},"status":{"example":"active","type":"string","description":"The status of the scope.","enum":["pending_approval","pending_hook","pending_approval_denied","pending","creating","recreating","active","updating","updating_approval","deleting","deleted","failed","stopping","stopped","cancelled"],"title":"ScopeStatus"}}}}}}}
>
  
</RequestSchema>

<StatusCodes
  id={undefined}
  label={undefined}
  responses={{"204":{"description":"The operation was successful.","content":{"application/json":{"schema":{"type":"object","required":["id","name","type"],"properties":{"id":{"type":"string","description":"The application-wide unique ID for the custom domain.","example":"e78a0d21-3c48-7421-81cd-203fe84b8e47"},"name":{"type":"string","description":"The name of the custom domain.","example":"api.crypto-inc.com"},"type":{"type":"string","description":"The type of the domain.","example":"scope"},"selector":{"type":"object","description":"The selector for the custom domain.","properties":{"organization_id":{"type":"string","description":"The organization ID.","example":"1"},"nrn":{"type":"string","description":"The NRN of entity.","example":"organization=1:account=2:namespace=3:application=4"},"scope_id":{"type":"string","description":"The scope ID that the custom domains is associated with..","example":"1234"}}},"status":{"type":"string","description":"The status of the domain.","enum":["active","pending"],"example":"active"},"created_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was created.","format":"date-time","example":"2025-01-02T00:00:00Z"},"updated_at":{"type":"string","description":"The ISO-8601 UTC timestamp of when the custom domain was last updated.","format":"date-time","example":"2025-02-02T00:00:00Z"}},"title":"scopeDomainResponse"}}}},"4XX":{"description":"Client error responses due to invalid input or missing parameters.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific client error (e.g., 400, 401, 403, 404).","example":400},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"bad_request"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Bad Request\", \"Unauthorized\").","example":"Bad Request"},"message":{"type":"string","description":"Additional details about the error.","example":"The request was malformed or contained invalid parameters."}}}}}},"5XX":{"description":"Server error responses indicating an issue on the API side.","content":{"application/json":{"schema":{"type":"object","required":["statusCode","error","message"],"properties":{"statusCode":{"type":"integer","description":"HTTP status code representing the specific server error (e.g., 500, 502, 503).","example":500},"code":{"type":"string","description":"A machine-readable error code that categorizes the server failure.","example":"internal_server_error"},"error":{"type":"string","description":"A brief, human-readable description of the error type (e.g., \"Internal Server Error\", \"Service Unavailable\").","example":"Internal Server Error"},"message":{"type":"string","description":"Additional details about the error.","example":"An unexpected error occurred. Please try again later."}}}}}}}}
>
  
</StatusCodes>