Invite Member - Square Cloud

POST

workspaces

members

Invite Member

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/members \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "code": "<string>",
  "group": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/members"

payload = {
    "workspaceId": "<string>",
    "code": "<string>",
    "group": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'code' => '<string>',
    'group' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/members"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

string

required

The API key for your account. You can find this in your account settings.

Adds a member to a workspace using a short-lived code from Get Invite Code: the invited user is identified by the code, and the caller assigns their role with group. Only the workspace owner can call this endpoint, and the workspace’s member count is capped by the owner’s plan tier. The four assignable roles control what a member can do to the workspace’s shared applications: view is read-only; manager can trigger app actions (start/stop/restart) and see deployment info but not commit or touch files; maintain adds file management, DNS, cache purge, and commits; admin adds environment variables, snapshots, custom domains, and the deploy webhook. Change a role later with Change Permissions. An owner cannot invite themselves. Rate limited to 1 addition every 5 seconds per user.

Parameters

string

The ID of the workspace.

string

A string with the member invite code.

string

The member permissions on the workspace applications

Response

string

Indicates whether the call was successful.. success if successful, error if not.

{
  "status": "success"
}

Common errors

Code	HTTP	Meaning
`INVALID_ID`	400	`workspaceId` is missing.
`INVALID_CODE`	400	The invite code is missing, malformed, or has expired.
`CANNOT_INVITE_OWNER`	400	The invite code belongs to the caller, who already owns the workspace.
`INVALID_GROUP`	400	`group` is not one of `view`, `manager`, `maintain`, `admin`.
`MEMBERS_LIMIT_REACHED`	400	The workspace already has the plan’s maximum number of members.
`MEMBER_ALREADY_ADDED`	400	The invited user is already a member of this workspace.
`WORKSPACE_NOT_FOUND`	404	The workspace does not exist.

Remove MemberRemove a workspace member from the workspace.

Invite Member

curl --request POST \
  --url https://api.squarecloud.app/v2/workspaces/members \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspaceId": "<string>",
  "code": "<string>",
  "group": "<string>"
}
'

import requests

url = "https://api.squarecloud.app/v2/workspaces/members"

payload = {
    "workspaceId": "<string>",
    "code": "<string>",
    "group": "<string>"
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({workspaceId: '<string>', code: '<string>', group: '<string>'})
};

fetch('https://api.squarecloud.app/v2/workspaces/members', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.squarecloud.app/v2/workspaces/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'workspaceId' => '<string>',
    'code' => '<string>',
    'group' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.squarecloud.app/v2/workspaces/members"

	payload := strings.NewReader("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<authorization>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.squarecloud.app/v2/workspaces/members")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.squarecloud.app/v2/workspaces/members")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"<string>\",\n  \"code\": \"<string>\",\n  \"group\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success"
}

​Parameters

​Response

​Common errors

Parameters

Response

Common errors