Network

Set or remove the application's custom domain

Sets or removes the application's custom domain. Pass custom: "@" to remove the existing custom domain. Replacing an existing domain releases the previous one before attaching the new one, unless another application of the account still uses it.

Available only on Standard, Pro, and Enterprise plans. The new domain must be a fully qualified domain name and cannot be a Square Cloud domain. The same account may attach one domain to multiple applications (load balancing): up to 2 applications on Standard, 5 on Pro, and 10 on Enterprise. A domain attached to another account is rejected.

Requires the workspace Administrator role (or ownership) when called against a workspace-shared application. Rate limited to 10 changes per 5 minutes and 50 per day per user.

post/v2/apps/{appId}/network/custom

Path parameters

appIdstring required

Application identifier. Optionally suffixed with -<workspaceId> to act on a workspace-shared application.

Request body

customstring required

Fully qualified domain to attach, or @ to remove.

Response

Custom domain set or removed.

status'success' required

Changes

No recorded changes to this endpoint across all 1 revision of this API.