Add a member to a workspace

workspace_admin.members.add(workspace_id, **kwargs) -> WorkspaceMember { actor_id, profile_id, added_at, 2 more }

POST/v1/account/workspaces/{workspaceId}/members

Grants a profile access to the workspace by creating (or reactivating) the actor that links the profile to the workspace. Accepts either an existing profile_id or an email to resolve-or-invite. Idempotent for an already-active member. Admin only.

ParametersExpand Collapse

workspace_id: String

email: String

Email address to add (resolve-or-invite). Mutually exclusive with profile_id.

profile_id: String

An existing account profile to add. Mutually exclusive with email.

ReturnsExpand Collapse

class WorkspaceMember { actor_id, profile_id, added_at, 2 more }

A member of a workspace: the profile granted access plus the actor row that links it to the workspace. Returned by member list/add operations.

actor_id: String

The actor row linking the profile to the workspace (the junction record).

profile_id: String

The account profile that has access to the workspace.

added_at: Time

When the member was added to the workspace.

formatdate-time

email: String

Email address of the member’s profile.

name: String

Display name of the member’s profile.

Add a member to a workspace

require "cadenya"

cadenya = Cadenya::Client.new(api_key: "My API Key")

workspace_member = cadenya.workspace_admin.members.add("workspaceId")

puts(workspace_member)

{
  "actorId": "actorId",
  "profileId": "profileId",
  "addedAt": "2019-12-27T18:11:19.117Z",
  "email": "email",
  "name": "name"
}

Returns Examples

{
  "actorId": "actorId",
  "profileId": "profileId",
  "addedAt": "2019-12-27T18:11:19.117Z",
  "email": "email",
  "name": "name"
}