v1Resources/Clients/postMake a standalone location a named client

Make a standalone location a named client

Convert a standalone location’s hidden client into a named client in place, preserving its identity, data, connections and access grants. Requires client-management permission and access to that client. Duplicate names, invalid names and already-managed clients are refused.

post/api/v1/clients/{id}/promote
clients:write
Query parameters
idstringrequired
Request body
businessNamestringrequired
Response
dataobjectrequired
promotedbooleanoptional
clientIdstringoptional
publicIdstringoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
409The request conflicts with the current state of the resource — for example, changing the email or phone of a recipient who has already been messaged, or a team invite that was already accepted (or hasn't been accepted yet).
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The service is temporarily unavailable. Retry a credit grant with the same idempotency key.
post/api/v1/clients/{id}/promote
Your API key
id *
Request body*
{}

Guides that use this resource