Rename or suspend someone

Suspending keeps the user in the directory and in their apps, but refuses their next sign-in and every request from their credentials.

PATCH/v1/users/{userId}

Request

curl --request PATCH \
  --url 'https://studio.gtable.app/v1/users/<userId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "status": "active"
}'

import json
import requests

url = "https://studio.gtable.app/v1/users/<userId>"
headers = {
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"name\":\"<string>\",\"status\":\"active\"}")

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

const response = await fetch("https://studio.gtable.app/v1/users/<userId>", {
  method: "PATCH",
  headers: {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "<string>",
    "status": "active"
  }),
});

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

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio.gtable.app/v1/users/<userId>");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "PATCH");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"name\":\"<string>\",\"status\":\"active\"}");
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("PATCH", "https://studio.gtable.app/v1/users/<userId>", bytes.NewBuffer([]byte("{\"name\":\"<string>\",\"status\":\"active\"}")))
  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.gtable.app/v1/users/<userId>"))
    .header("Authorization", "Bearer <token>")
    .header("Content-Type", "application/json")
    .method("PATCH", HttpRequest.BodyPublishers.ofString("{\"name\":\"<string>\",\"status\":\"active\"}"))
    .build();

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

require 'net/http'
require 'json'

uri = URI("https://studio.gtable.app/v1/users/<userId>")
request = Net::HTTP::Patch.new(uri)
request["Authorization"] = "Bearer <token>"
request["Content-Type"] = "application/json"
request.body = "{\"name\":\"<string>\",\"status\":\"active\"}"

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": {
    "userId": "<string>",
    "name": null,
    "status": "<string>"
  }
}

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

Reinstating is the same call with status active.

Requires the members:write scope. Operation users.update. MCP tool users_update. CLI, once published: gtable users update.

Path parameters

Name	Type	Required	Description
`userId`	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
`name`	string or null	no
`status`	“active” or “invited” or “suspended”	no

Response

application/json

Success

dataobjectrequired

Show child attributes

userIdstringrequired

namestringnullrequired

statusstringrequired

curl --request PATCH \ --url 'https://studio.gtable.app/v1/users/<userId>' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "<string>", "status": "active" }'

Rename or suspend someone

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