Add a member to a workspace

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.

Path ParametersExpand Collapse

workspaceId: string

Body ParametersJSONExpand Collapse

email: optional string

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

profileId: optional string

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

ReturnsExpand Collapse

WorkspaceMember object { actorId, profileId, addedAt, 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.

actorId: string

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

profileId: string

The account profile that has access to the workspace.

addedAt: optional string

When the member was added to the workspace.

formatdate-time

email: optional string

Email address of the member’s profile.

name: optional string

Display name of the member’s profile.

Add a member to a workspace

curl https://api.cadenya.com/v1/account/workspaces/$WORKSPACE_ID/members \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CADENYA_API_KEY" \
    -d '{}'

{
  "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"
}