API Console
test
Sign in with BES

Person Channel Identity Swap Request

MANAGE_PEOPLE and an active target membership are required. Records an admin-initiated replacement request and queues only the new-channel code; Control's delivery worker sends it after commit, so a 202 means queued, not sent. The person completes the swap from the authenticated account page; management cannot complete it. Original and replacement address remain unchanged until code consumption; completing the swap advances the person's binding version, one value shared by every tenant. A retry with the same request_ref returns the first response, including its request_id. A newer request for the same person replaces the pending one and its codes. Email proofs go to that email; telephone proofs require the tenant WhatsApp grant. Codes never appear in responses.

POST https://id.test.globalbes.sg:9443/internal/control/v1/people/{person_id}/channel-identities/{id}/swap
Called byTenant admin AuthService certificate+ signed-in user (optional)
Path
uuid
uuid
Headers
uuid
Optional acting person named by a service that authenticated them; when a user token is sent it must name the same person.
Body
string
uuid
string
string
Sign in to sendBrowsing needs no sign-in
Request preview
POST /internal/control/v1/people/{person_id}/channel-identities/{id}/swap
Response

Choose an API and send a request.

Caller tags:BOSSTenant adminAll productsMobile appMessagingControlAIAssistantPlatform opsLegacy productsCI release