Add a member to a workspace

client.WorkspaceAdmin.Members.Add(ctx, workspaceID, body) (*WorkspaceMember, error)

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

workspaceID string

body WorkspaceAdminMemberAddParams

Email param.Field[string]Optional

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

ProfileID param.Field[string]Optional

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

ReturnsExpand Collapse

type WorkspaceMember struct{…}

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 TimeOptional

When the member was added to the workspace.

formatdate-time

Email stringOptional

Email address of the member’s profile.

Name stringOptional

Display name of the member’s profile.

Add a member to a workspace

package main

import (
  "context"
  "fmt"

  "github.com/cadenya/cadenya-go"
  "github.com/cadenya/cadenya-go/option"
)

func main() {
  client := cadenya.NewClient(
    option.WithAPIKey("My API Key"),
  )
  workspaceMember, err := client.WorkspaceAdmin.Members.Add(
    context.TODO(),
    "workspaceId",
    cadenya.WorkspaceAdminMemberAddParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", workspaceMember.ActorID)
}

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