Remove a member

DELETE/api/embed/v1/accounts/{accountId}/members/{userId}

Removes a person from one workspace, or from the whole account.

Needs a partner key: Authorization: Bearer gre_…, from Platform › Partner keys. Call it from your server only.

Embed · Self-hosted with an Embed license

Parameters

Path

accountIdRequired · string: Your ID for the customer’s account: 1 to 255 bytes of UTF-8, case-sensitive. URL-encode it: it may contain /.
userIdRequired · string: Your ID for the person.

Query

workspaceIdOptional · string: Only this workspace. Left out: every workspace of the account.

Their last workspace

Removed from the last workspace they had in the account, they leave the account too.

Responses

204No Content
Removed. Their sessions there end (access_removed).
400VALIDATION_ERROR
A parameter isn’t valid, such as an empty workspaceId.
404NOT_FOUND
No such account, workspace or member.
409ACCOUNT_DELETED
The account is deleted. Restore it first, within 30 days.
500INTERNAL_ERROR
Something failed on the installation’s side. Try again.

Any call can also answer: 401 UNAUTHORIZED · 403 EMBED_NOT_LICENSED · 403 IP_NOT_ALLOWED · 429 RATE_LIMITED · 503 BUSY. See Errors.

Request

GORUNNER="https://automations.example.com"
GORUNNER_EMBED_KEY="YOUR_PARTNER_KEY"  # gre_…
ACCOUNT_ID="acct-bakery"
USER_ID="ada-123"

URL="$GORUNNER/api/embed/v1/accounts/$ACCOUNT_ID/"
URL="${URL}members/$USER_ID"
curl -X DELETE "$URL" \
  -H "Authorization: Bearer $GORUNNER_EMBED_KEY"

const GORUNNER = "https://automations.example.com";
const KEY = process.env.GORUNNER_EMBED_KEY; // gre_…
const ACCOUNT_ID = encodeURIComponent("acct-bakery");
const USER_ID = encodeURIComponent("ada-123");

const res = await fetch(
  `${GORUNNER}/api/embed/v1/accounts/` +
    `${ACCOUNT_ID}/members/${USER_ID}`,
  {
    method: "DELETE",
    headers: { Authorization: `Bearer ${KEY}` },
  },
);
console.log(res.status); // 204

import os, requests
from urllib.parse import quote

GORUNNER = "https://automations.example.com"
KEY = os.environ["GORUNNER_EMBED_KEY"]  # gre_…
ACCOUNT_ID = quote("acct-bakery", safe="")
USER_ID = quote("ada-123", safe="")

res = requests.delete(
    f"{GORUNNER}/api/embed/v1/accounts/"
    f"{ACCOUNT_ID}/members/{USER_ID}",
    headers={"Authorization": f"Bearer {KEY}"},
)
print(res.status_code)  # 204

Response · 204 No Content

http

HTTP/1.1 204 No Content

Every field

It takes no body.

204 No Content: no body.