Docs / Reference / act: invite

act: invite.

An address and a role to the invitation, open, with its expiry

Figure 1POST /v1/act/invitespecified

The caller sends InviteInput to /v1/act/invite. The platform returns a card whose body is Invitation.

POST/v1/act/invite

Invite a person. The call needs the tenant rung under a token with the admin grant, and it is served by the platform.

The route takes InviteInput and returns a card whose body is Invitation.

Request body#

The request body is InviteInput.

field	type	required	note
`address`	`text`	yes
`role`	`text`	yes
`held_on`	Scope	no	the tenant, brand or strategy the role is held on; absent means the whole tenant, which a guest may not hold (a guest holds roles only on the brands they were invited to)

Response#

The route returns a card whose body is Invitation. Every card ends with a foot that states the basis of each number, the scope of the call, and the time when the facts were true.

Headers#

header	required	meaning
`Scale-Scope`	yes	the scope the call runs in: tenant/, then /brand/, then /strategy/
`Scale-As-True-On`	no	the date the facts must have been true on; defaults to now
`Scale-As-Known-On`	no	the date the facts must have been known on; defaults to now
`Scale-Key`	no	for a change, the key made from the input; a repeat under the same key returns the unit held and writes nothing

A caller needs the tenant rung and a token with the admin grant. The platform serves this route.

Example#

The example sends the smallest body that InviteInput allows. The build validates it against the schema of InviteInput.

Example

curl -X POST https://api.scaleintelligence.co/v1/act/invite \
  -H "Scale-Key: $SCALE_KEY" -H "Scale-Scope: tenant/<id>" \
  -H "content-type: application/json" \
  -d '{ "address": "…", "role": "…" }'

import { client } from "@scale/sdk";
const answer = await client.act.invite({
    "address": "…",
    "role": "…"
  });
// answer.body is a Invitation. answer.foot holds the basis, the scope and the time.

import requests
answer = requests.post("https://api.scaleintelligence.co/v1/act/invite",
    headers={"Scale-Key": KEY, "Scale-Scope": "tenant/<id>"},
    json={
      "address": "…",
      "role": "…"
    }).json()

let answer: Card = client.post("https://api.scaleintelligence.co/v1/act/invite")
    .header("Scale-Key", key).header("Scale-Scope", "tenant/<id>")
    .json(&InviteInput { /* the fields of the page */ }).send().await?.json().await?;

MCP tool#

The MCP tool si.act.invite takes the same input and returns the same card. The tool changes data and needs a grant. An MCP host that renders cards draws this card from ui://scale-intelligence/cards/Invitation. The tool’s page describes it.

POST /v1/act/invite
Scale-Scope: …
Scale-As-True-On: …
Scale-As-Known-On: …
Scale-Key: …
content-type: application/json

{
  "address": "…",
  "role": "…"
}

Without a key, this page shows the request only. The request body is InviteInput, and the route returns a card whose body is Invitation.

Claims#

claim	state	route or tool
The platform serves the route /v1/act/invite at contract 0476e35e6e275db5.	target	`/v1/act/invite`