Turn the builder invite link on, renew it, or turn it off

Admins only.

PUT/v1/organizations/{organizationId}/builders/invite-link

Request

curl --request PUT \
  --url 'https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "enabled": true
}'

import json
import requests

url = "https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"enabled\":true}")

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

const response = await fetch("https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link", {
  method: "PUT",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "enabled": true
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PUT");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"enabled\":true}");
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("PUT", "https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link", bytes.NewBuffer([]byte("{\"enabled\":true}")))
  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/organizations/<organizationId>/builders/invite-link"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PUT", HttpRequest.BodyPublishers.ofString("{\"enabled\":true}"))
    .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/organizations/<organizationId>/builders/invite-link")
request = Net::HTTP::Put.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"enabled\":true}"

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": {
    "enabled": true
  }
}

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

enabled: true makes a new link valid for seven days and the previous one stops working at once, so it also renews an expired link. enabled: false stops the current link; nobody already in the organisation is removed.

Requires the members:write scope. Operation builders.inviteLink.set. MCP tool builders_inviteLink_set. CLI: grid82 builders invite-link set (npx grid82).

Path parameters

Name	Type	Required	Description
`organizationId`	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
`enabled`	boolean	yes

Response

application/json

Success

dataobjectrequired

Show child attributes

data.enabledbooleanrequired

curl --request PUT \ --url 'https://studio.grid82.app/v1/organizations/<organizationId>/builders/invite-link' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "enabled": true }'

Turn the builder invite link on, renew it, or turn it off

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