Skip to main content
POST
/
v1
/
member-access
Create or upsert a workspace member access assignment
curl --request POST \
  --url http://localhost:3001/v1/member-access \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "jsmith@example.com",
  "clerkUserId": "<string>",
  "invitedByUserId": "<string>"
}
'
{
  "roles": [
    {
      "name": "<string>",
      "description": "<string>",
      "locked": true,
      "permissions": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "assignments": [
    {
      "id": "<string>",
      "email": "jsmith@example.com",
      "clerkUserId": "<string>",
      "invitedByUserId": "<string>",
      "activatedAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Headers

​
authorization
string
Minimum string length: 1
​
x-organization-id
string
Minimum string length: 1

Body

application/json
​
email
string<email>
required
Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$
​
roleId
enum<string>
required
Available options:
admin,
operations,
read_only
​
status
enum<string>
required
Available options:
pending,
active
​
clerkUserId
string | null
Minimum string length: 1
​
invitedByUserId
string | null
Minimum string length: 1

Response

Default Response

​
roles
object[]
required
​
assignments
object[]
required