Manage teams

Example: Identify a team before checking invitation eligibility

Read the first page. This excerpt shows team 1001 and empty embedded invite/Pricing collections; additional full-team fields are omitted.

curl "${WALLKIT_API_BASE}/api/v1/user/teams?page=1&limit=10" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams?page=1&limit=10`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams?page=1&limit=10",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "items": [
    {
      "id": 1001,
      "name": "Example Media",
      "users_count": 1,
      "invites_count": 0,
      "invites": [],
      "subscription": []
    }
  ],
  "paginator": {
    "current_page": 1,
    "page": 1,
    "total_pages": 1,
    "total_items": 1,
    "limit": 10
  }
}

Example: Create one invite for team 1001

Choose an already eligible free Pricing 2001, so the example does not imply owner payment or paid activation. Omit code/resource_id; header resource controls storage. The synthetic code below represents the returned generated code, not a supplied custom code.

curl -X POST "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-raw '{"email": "reader@example.com", "user_name": "Alex Reader", "subscription_id": 2001}'

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites`, {
  method: "POST", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN, "Content-Type": "application/json" },
  body: JSON.stringify({"email": "reader@example.com", "user_name": "Alex Reader", "subscription_id": 2001})
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

body = {'email': 'reader@example.com', 'user_name': 'Alex Reader', 'subscription_id': 2001}
request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites",
    data=json.dumps(body).encode("utf-8"), headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"], "Content-Type": "application/json"}, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 201 excerpt:

{
  "id": 3001,
  "email": "reader@example.com",
  "user_name": "Alex Reader",
  "title": "Invite for Example Media team",
  "code": "SYNTHETIC-INVITE-CODE-DO-NOT-USE-0000000001",
  "activations_limit": 1
}

Store the returned code for the intended invitee flow; ID 3001 is for invitation management.

Example: Create an explicitly typed company team

Create Example Media with type company rather than guessing an omitted type default. Response excerpt omits owner/member detail.

curl -X POST "${WALLKIT_API_BASE}/api/v1/user/teams" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-raw '{"name": "Example Media", "type": "company", "description": "Example publishing team"}'

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams`, {
  method: "POST", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN, "Content-Type": "application/json" },
  body: JSON.stringify({"name": "Example Media", "type": "company", "description": "Example publishing team"})
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

body = {'name': 'Example Media', 'type': 'company', 'description': 'Example publishing team'}
request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams",
    data=json.dumps(body).encode("utf-8"), headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"], "Content-Type": "application/json"}, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 201 excerpt:

{
  "id": 1001,
  "name": "Example Media",
  "type": "company",
  "active": true,
  "member_limit": 0,
  "invites": [],
  "users_count": 1
}

Example: Rename team without changing seats

This request expresses an intended name-only update for team 1001. A reachable completed success example is N/A in the available source because the post-save comparison helper is unresolved; the conditional projection below teaches the intended response without certifying it.

curl -X PUT "${WALLKIT_API_BASE}/api/v1/user/teams/1001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-raw '{"name": "Example Newsroom"}'

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001`, {
  method: "PUT", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN, "Content-Type": "application/json" },
  body: JSON.stringify({"name": "Example Newsroom"})
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

body = {'name': 'Example Newsroom'}
request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001",
    data=json.dumps(body).encode("utf-8"), headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"], "Content-Type": "application/json"}, method="PUT")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Intended synthetic HTTP 200 projection only, conditional on the unresolved helper being available:

{
  "id": 1001,
  "name": "Example Newsroom",
  "type": "company",
  "member_limit": 0
}

Example: Interpret the delete result for team 1001

Only for the intended deletion task, construct this request. No user/provider account deletion or refund is implied.

curl -X DELETE "${WALLKIT_API_BASE}/api/v1/user/teams/1001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001`, {
  method: "DELETE", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="DELETE")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 1001,
  "result": true
}

Example: Read team 1001 without treating detail as a Pricing list

Inspect id/name/counts and role/status for each returned user in the full projection. This excerpt omits sensitive nested contact/invite fields.

curl "${WALLKIT_API_BASE}/api/v1/user/teams/1001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 1001,
  "name": "Example Media",
  "users_count": 1,
  "invites_count": 0,
  "invites": [],
  "users": [
    {
      "id": 4001,
      "role": "owner",
      "status": "active"
    }
  ]
}

Example: Inspect invite 3001 and activation count

Read first invitation page for team 1001. This excerpt omits rich record fields.

curl "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites?page=1&limit=10" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites?page=1&limit=10`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites?page=1&limit=10",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "items": [
    {
      "id": 3001,
      "email": "reader@example.com",
      "activations": 0,
      "used": null
    }
  ],
  "paginator": {
    "current_page": 1,
    "page": 1,
    "total_pages": 1,
    "total_items": 1,
    "limit": 10
  }
}

Example: Read invite 3001 under team 1001

Use the invitation ID from creation/listing; response excerpt shows its redeemable code separately.

curl "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites/3001",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 3001,
  "email": "reader@example.com",
  "code": "SYNTHETIC-INVITE-CODE-DO-NOT-USE-0000000001",
  "activations_limit": 1
}

Example: Change invite 3001’s display title without resending

Update title only; the returned code remains the existing code unless it was empty before save.

curl -X PUT "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-raw '{"title": "Join Example Newsroom"}'

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001`, {
  method: "PUT", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN, "Content-Type": "application/json" },
  body: JSON.stringify({"title": "Join Example Newsroom"})
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

body = {'title': 'Join Example Newsroom'}
request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites/3001",
    data=json.dumps(body).encode("utf-8"), headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"], "Content-Type": "application/json"}, method="PUT")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 3001,
  "email": "reader@example.com",
  "title": "Join Example Newsroom",
  "code": "SYNTHETIC-INVITE-CODE-DO-NOT-USE-0000000001"
}

Example: Delete invite 3001 without treating it as member removal

To remove invitation 3001 from team 1001, use the manager context that passes this action’s eligibility check. The operation attempts invitation-record deletion; it does not remove a team member.

curl -X DELETE "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001`, {
  method: "DELETE", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites/3001",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="DELETE")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "result": true
}

Example: Request another notification for invite 3001

Select the intended existing team/invite pair. The stored recipient reader@example.com is used; no new body email/code is accepted.

curl -X POST "${WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001/resend" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/invites/3001/resend`, {
  method: "POST", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/invites/3001/resend",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "result": true
}

Example: Use the same resend action with admin-prefix context

Select the intended existing team/invite pair. The stored recipient reader@example.com is used; no new body email/code is accepted.

curl -X POST "${WALLKIT_API_BASE}/api/v1/admin/teams/1001/invites/3001/resend" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/admin/teams/1001/invites/3001/resend`, {
  method: "POST", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/admin/teams/1001/invites/3001/resend",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="POST")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "result": true
}

Example: Inspect user 4002 without confusing it with a relationship ID

Read first page of non-owner users for team 1001. The excerpt deliberately has no role/status, which this list does not add.

curl "${WALLKIT_API_BASE}/api/v1/user/teams/1001/users?page=1&limit=10" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/users?page=1&limit=10`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/users?page=1&limit=10",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "items": [
    {
      "id": 4002,
      "email": "reader@example.com",
      "subscriptions": []
    }
  ],
  "paginator": {
    "current_page": 1,
    "page": 1,
    "total_pages": 1,
    "total_items": 1,
    "limit": 10
  }
}

Example: Read user 4002’s selected-resource account state

Use the person ID from list/team detail. This excerpt omits resource profile fields and nested membership/team objects.

curl "${WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002`, {
  method: "GET", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/users/4002",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="GET")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 4002,
  "email": "reader@example.com",
  "subscriptions": [],
  "teams": []
}

Example: Change role/status without invoking disabled Pricing checkout

Use a status/role-only request for user 4002. No subscription_id is sent. Intended ordinary success projection can show resource account state while the selected team relationship differs.

curl -X PUT "${WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}" \
  -H "Content-Type: application/json" \
  --data-raw '{"role": "user", "status": "active"}'

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002`, {
  method: "PUT", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN, "Content-Type": "application/json" },
  body: JSON.stringify({"role": "user", "status": "active"})
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

body = {'role': 'user', 'status': 'active'}
request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/users/4002",
    data=json.dumps(body).encode("utf-8"), headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"], "Content-Type": "application/json"}, method="PUT")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "id": 4002,
  "email": "reader@example.com",
  "subscriptions": [],
  "teams": []
}

Example: Remove user 4002 from active team participation

As a permitted team manager, mark user 4002 removed from team 1001. Use the person ID, without a relationship ID or status body.

curl -X DELETE "${WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002`, {
  method: "DELETE", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/users/4002",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="DELETE")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "result": true
}

Example: Suspend user 4002’s team participation

As a permitted team manager, suspend user 4002’s participation in team 1001. Use the person ID, without a relationship ID or status body.

curl -X PATCH "${WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002" \
  -H "resource: ${RESOURCE_KEY}" \
  -H "token: ${USER_TOKEN}"

const response = await fetch(`${process.env.WALLKIT_API_BASE}/api/v1/user/teams/1001/users/4002`, {
  method: "PATCH", headers: { "resource": process.env.RESOURCE_KEY, "token": process.env.USER_TOKEN }
});
console.log(response.status, await response.json());

import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request = Request(os.environ["WALLKIT_API_BASE"] + "/api/v1/user/teams/1001/users/4002",
    headers={"resource": os.environ["RESOURCE_KEY"], "token": os.environ["USER_TOKEN"]}, method="PATCH")
try:
    with urlopen(request) as response:
        print(response.status, json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))

Synthetic HTTP 200 excerpt:

{
  "result": true
}