Share a space with a person

POST /spaces/{spaceId}/members

Updated 17 Sep 20262 min read

POST/spaces/{spaceId}/membersTry it

Basehttps://api.mockflow.com/v1Scopesmembers:write

Request

curl https://api.mockflow.com/v1/spaces/spc_92kd/members \
  -X POST \
  -H "Authorization: Bearer $MOCKFLOW_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "jane@acme.com",
  "role": "admin"
}'

const response = await fetch("https://api.mockflow.com/v1/spaces/spc_92kd/members", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.MOCKFLOW_API_KEY}`,
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "email": "jane@acme.com",
  "role": "admin"
})
});

const data = await response.json();

import os, requests

response = requests.post(
    "https://api.mockflow.com/v1/spaces/spc_92kd/members",
    headers={"Authorization": f"Bearer {os.environ['MOCKFLOW_API_KEY']}"},
    json={
  "email": "jane@acme.com",
  "role": "admin"
},
)

response.raise_for_status()
data = response.json()

Response

{
  "id": "string",
  "email": "jane@acme.com",
  "name": "Q4 Launch Planning",
  "role": "owner",
  "hasAccount": false,
  "invited": false
}

{
  "id": "string",
  "email": "jane@acme.com",
  "name": "Q4 Launch Planning",
  "role": "owner",
  "hasAccount": false,
  "invited": false
}

{
  "error": {
    "code": "plan_limit",
    "message": "AI credits exhausted. 0 of 2000 remaining this month.",
    "upgradeUrl": "https://mockflow.com/pricing"
  },
  "requestId": "req_01ja"
}

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests.",
    "docsUrl": "https://mockflow.com/developers/concepts/errors#rate_limited"
  },
  "requestId": "req_45d49816999bac40"
}

Adds or updates the person's role. The first time someone is added an invitation email is sent, worded as the app sends it. Basic can share as reviewer only, up to five people per space. A shared admin or editor may share too, as in the app.

Authorization

Authorizationstringheaderrequired

Bearer <key>. The key needs members:write scope. Create and manage keys in the developer console; what each scope unlocks is on the scopes page.

Path parameters

spaceIdstringpathrequired

Body

application/json

emailstringrequired

roleenum<string>required

One of admin, editor or reviewer.

Response

200 · application/json

idstring

emailstring

namestring

roleenum<string>

The product's roles. Owner is the workspace that holds the board or space and cannot be granted or transferred. Admin can rename and share, editor can edit, reviewer can view, export and add comment items. There is no viewer role and no pending state. One of owner, admin, editor or reviewer.

hasAccountboolean

False for someone invited who has not signed up yet.

invitedboolean

Set on the response to a first add when the invitation mail went out.

Errors

402plan_limit

The workspace plan does not allow this, or AI credits are exhausted.

429rate_limited

Too many requests.

Was this page helpful?