Update Workspace Config

PATCH

{workspace}

config

curl -X PATCH "https://management-api.suprsend.com/v1/{workspace}/config/" \
  --header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"user_tenancy_mode":"shared"}'

import requests

url = "https://management-api.suprsend.com/v1/{workspace}/config/"

payload = { "user_tenancy_mode": "shared" }
headers = {
    "ServiceToken <token>": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'ServiceToken <token>': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_tenancy_mode: 'shared'})
};

fetch('https://management-api.suprsend.com/v1/{workspace}/config/', 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://management-api.suprsend.com/v1/{workspace}/config/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'user_tenancy_mode' => 'shared'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "ServiceToken <token>: <api-key>"
  ],
]);

$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://management-api.suprsend.com/v1/{workspace}/config/"

	payload := strings.NewReader("{\n  \"user_tenancy_mode\": \"shared\"\n}")

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

	req.Header.Add("ServiceToken <token>", "<api-key>")
	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.patch("https://management-api.suprsend.com/v1/{workspace}/config/")
  .header("ServiceToken <token>", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_tenancy_mode\": \"shared\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/config/")

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

request = Net::HTTP::Patch.new(url)
request["ServiceToken <token>"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_tenancy_mode\": \"shared\"\n}"

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

{
  "user_inbox_preference_enabled": true,
  "sms_vendor_type": "basic",
  "user_tenancy_mode": "shared",
  "user_tenancy_channel_fallback_mode": "allowlist",
  "user_tenancy_channel_fallback": [
    "$email",
    "$sms",
    "$whatsapp"
  ],
  "user_tenancy_channel_fallback_applies_to_default_tenant": false
}

{
  "code": 123,
  "error_code": "<string>",
  "type": "<string>",
  "message": "<string>",
  "detail": "<string>"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

Authorizations

ServiceToken <token>

string

header

required

You can get Service Token from SuprSend dashboard -> Account Settings -> Service Tokens section.

Path Parameters

workspace

string

required

Workspace slug (e.g. staging, production).

Body

application/json

Body for PATCH /v1/{workspace}/config/. Include only the fields you want to change — omitted fields are left untouched.

user_inbox_preference_enabled

boolean

If you are using the Inbox channel, enable this to show the Inbox channel in the preference centre.

Example:

true

sms_vendor_type

enum<string>

Switch the workspace's SMS delivery mode. Confirm with your SMS provider before switching to or from dlt.

Available options:

basic,

dlt

Example:

"basic"

user_tenancy_mode

enum<string>

Change how users are constrained across tenants. See User-tenant mapping for the effects of switching this value.

Available options:

shared,

exclusive

Example:

"shared"

user_tenancy_channel_fallback_mode

enum<string>

Switch between all (every channel falls back from global) and allowlist (only channels in user_tenancy_channel_fallback fall back).

Available options:

all,

allowlist

Example:

"allowlist"

user_tenancy_channel_fallback

string[]

Channel keys allowed to fall back when user_tenancy_channel_fallback_mode = allowlist. Ignored otherwise.

Example:

["$email", "$sms", "$whatsapp"]

user_tenancy_channel_fallback_applies_to_default_tenant

boolean

When true, the fallback rule above also governs sends with no tenant_id.

Example:

false

Response

Workspace config updated. The full updated config is returned.

Workspace-level configuration flags.

user_inbox_preference_enabled

boolean

If you are using the Inbox channel, enable this to show the Inbox channel in the preference centre.

Example:

true

sms_vendor_type

enum<string>

SMS delivery mode for the workspace. Use dlt for India DLT-compliant sends; basic for standard sends.

Available options:

basic,

dlt

Example:

"basic"

user_tenancy_mode

enum<string>

Constraint on user-tenant associations for this workspace.

shared — a user can belong to any number of tenants.
exclusive — a user can belong to at most one tenant. The associate call rejects users that already have a mapping.

New workspaces default to exclusive; workspaces that existed before this setting was introduced default to shared.

Available options:

shared,

exclusive

Example:

"exclusive"

user_tenancy_channel_fallback_mode

enum<string>

Controls which channels a tenant-scoped profile is allowed to inherit from the user's global profile when the tenant has no override for that channel.

all — every channel falls back to global (default; reproduces a straight shallow merge).
allowlist — only the channels listed in user_tenancy_channel_fallback fall back; every other channel is dropped from the send when the tenant has no override for it. Prevents identities like $androidpush or $slack from leaking across tenants.

Available options:

all,

allowlist

Example:

"all"

user_tenancy_channel_fallback

string[]

Channel keys allowed to fall back from the global profile when user_tenancy_channel_fallback_mode = allowlist. Ignored when the mode is all.

Typical setup: ["$email", "$sms", "$whatsapp"] — safe to fall back — while excluding $androidpush, $iospush, $webpush, $inbox, and $slack.

Example:

["$email", "$sms", "$whatsapp"]

user_tenancy_channel_fallback_applies_to_default_tenant

boolean

default:false

Whether the fallback rule above also governs sends that carry no tenant_id (the default-tenant path).

false (default) — the default-tenant path always falls back for every channel, regardless of the allowlist.
true — the default-tenant path follows the same user_tenancy_channel_fallback_mode + user_tenancy_channel_fallback rule as other tenants.

Example:

false

List API KeysList API keys scoped to a workspace. Secret values are never returned on list; only a masked preview is shown.

⌘I

Update Workspace Config

curl -X PATCH "https://management-api.suprsend.com/v1/{workspace}/config/" \
  --header 'Authorization: ServiceToken <SERVICE_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{"user_tenancy_mode":"shared"}'

import requests

url = "https://management-api.suprsend.com/v1/{workspace}/config/"

payload = { "user_tenancy_mode": "shared" }
headers = {
    "ServiceToken <token>": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'ServiceToken <token>': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({user_tenancy_mode: 'shared'})
};

fetch('https://management-api.suprsend.com/v1/{workspace}/config/', 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://management-api.suprsend.com/v1/{workspace}/config/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'user_tenancy_mode' => 'shared'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "ServiceToken <token>: <api-key>"
  ],
]);

$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://management-api.suprsend.com/v1/{workspace}/config/"

	payload := strings.NewReader("{\n  \"user_tenancy_mode\": \"shared\"\n}")

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

	req.Header.Add("ServiceToken <token>", "<api-key>")
	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.patch("https://management-api.suprsend.com/v1/{workspace}/config/")
  .header("ServiceToken <token>", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"user_tenancy_mode\": \"shared\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://management-api.suprsend.com/v1/{workspace}/config/")

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

request = Net::HTTP::Patch.new(url)
request["ServiceToken <token>"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"user_tenancy_mode\": \"shared\"\n}"

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

{
  "user_inbox_preference_enabled": true,
  "sms_vendor_type": "basic",
  "user_tenancy_mode": "shared",
  "user_tenancy_channel_fallback_mode": "allowlist",
  "user_tenancy_channel_fallback": [
    "$email",
    "$sms",
    "$whatsapp"
  ],
  "user_tenancy_channel_fallback_applies_to_default_tenant": false
}

{
  "code": 123,
  "error_code": "<string>",
  "type": "<string>",
  "message": "<string>",
  "detail": "<string>"
}

{
  "code": 401,
  "error_code": "authentication_failed",
  "type": "AuthenticationFailed",
  "message": "Invalid service token.",
  "detail": "Invalid service token."
}

{
  "code": 404,
  "error_code": "not_found",
  "type": "NotFound",
  "message": "workspace 'demo' not found",
  "detail": "workspace 'demo' not found"
}

API Reference

WORKSPACE & AUTH KEYS

WORKFLOWS

SCHEMAS

EVENTS

CATEGORIES

TRANSLATIONS

TEMPLATES

Authorizations

Path Parameters

Body

Response