Update Client Registration Link (v1)

Method & Path

PATCH /api/v1/workspace/:workspaceId/clients/registration-link

Actual backend path: /v1/workspace/:workspaceId/clients/registration-link

Description

Regenerate the one-time client self-registration invite. A new token invalidates the previous URL and clears any previous usage so the new link can be sent to another person.

note

The enabled field is accepted for backward compatibility but ignored. One-time links are active until used; there is no public-link toggle.

Authentication

Required: Workspace Owner JWT or Staff JWT.

Persona access:

• Workspace Owner: full access
• Staff with client.create: can regenerate

Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer token
Content-Type	string	Yes	application/json

Path Parameters

Parameter	Type	Required	Description
workspaceId	string	Yes	Workspace identifier

Request Body

{
  "regenerate": true
}

Parameter	Type	Required	Description
regenerate	boolean	No	When true, issues a fresh unused token
enabled	boolean	No	Ignored (legacy)

Response 200 OK

{
  "link": {
    "enabled": true,
    "status": "available",
    "token": "d4e5f6...",
    "publicPath": "/register/d4e5f6...",
    "registeredName": null
  }
}

Common Errors

• 401 Unauthorized: Missing or invalid authentication token
• 404 Not Found: Workspace not found
• 500 Internal Server Error: Unexpected server error