Create an invite link

Create a single-use link that adds anyone who opens it to one app in this suite with exactly these roles, after signing in at the suite's address.

POST/v1/suites/{suiteId}/invites

Request

curl --request POST \
  --url 'https://studio.grid82.app/v1/suites/<suiteId>/invites' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "appId": "<string>",
  "roles": [
    "<string>"
  ]
}'

import json
import requests

url = "https://studio.grid82.app/v1/suites/<suiteId>/invites"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"appId\":\"<string>\",\"roles\":[\"<string>\"]}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio.grid82.app/v1/suites/<suiteId>/invites", {
  method: "POST",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "appId": "<string>",
    "roles": [
      "<string>"
    ]
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/suites/<suiteId>/invites");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"appId\":\"<string>\",\"roles\":[\"<string>\"]}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio.grid82.app/v1/suites/<suiteId>/invites", bytes.NewBuffer([]byte("{\"appId\":\"<string>\",\"roles\":[\"<string>\"]}")))
  req.Header.Set("Authorization", "Bearer <token>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio.grid82.app/v1/suites/<suiteId>/invites"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"appId\":\"<string>\",\"roles\":[\"<string>\"]}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio.grid82.app/v1/suites/<suiteId>/invites")
request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"appId\":\"<string>\",\"roles\":[\"<string>\"]}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": {
    "id": "<string>",
    "url": "<string>",
    "appId": "<string>",
    "roles": [
      "<string>"
    ],
    "label": null,
    "expiresAt": "<string>",
    "maxUses": null
  }
}

{
  "error": {
    "code": "not_found",
    "message": "<string>",
    "details": {}
  }
}

It works when the suite is invitation-only and can add a new person to the directory. It cannot set a password for an address already in the directory; that person needs their own link (users.passwordLink). Pass maxUses to allow multiple uses, or null for unlimited. The URL is returned once and never stored in clear; copy it now.

Requires the members:write scope. Operation invites.create. MCP tool invites_create. CLI: grid82 invites create (npx grid82).

Path parameters

Name	Type	Required	Description
`suiteId`	string	yes

Headers

Name	Type	Required	Description
`Idempotency-Key`	string	no	Any unique string. Sending the same key with the same request again returns the first response (marked `Idempotency-Replayed: true`) instead of running it twice. Reusing it for a different request is refused with 409. Kept for 24 hours. Up to 255 characters.

Request body

Field	Type	Required	Description
`appId`	string	yes	Up to 64 characters.
`roles`	string[]	yes
`label`	string	no	Up to 60 characters.
`expiresInDays`	integer	no	Default `14`. At least 1. At most 90.
`maxUses`	integer or null	no

Response

application/json

Success

dataobjectrequired

Show child attributes

data.idstringrequired

data.urlstringrequired

data.appIdstringrequired

data.rolesstring[]required

data.labelstringnullrequired

data.expiresAtstringrequired

data.maxUsesnumbernullrequired

curl --request POST \ --url 'https://studio.grid82.app/v1/suites/<suiteId>/invites' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "appId": "<string>", "roles": [ "<string>" ] }'

Create an invite link

Path parameters

Headers

Request body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown