组织管理

邀请成员

Changed on

管理员直接添加用户为组织成员

post/organizations/{id}/invite

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/organizations/{id}/invite
  • Auth
    API key in header Authorization

Path parameters

idstring required

组织ID

Request body

representative_user_idstring

RepresentativeUserID is accepted for compatibility and ignored: a direct add attaches no user of the enrolled workspace, since the inviter must not choose whose details the roster shows.

role'admin' | 'editor' | 'viewer' required
tenant_idinteger

TenantID is the workspace to enrol as an org member. Preferred field.

user_idstring

UserID is retained for backward compatibility. When set without TenantID, the handler resolves the user's TenantID.

Response

OK

messagestring
successboolean

Example response

{
  "success": true
}

Changes