Workspaces

Get Workspace Config

Retrieve workspace-level configuration flags — the settings that govern behavior for every user, tenant, and workflow inside this workspace.

Fields returned:

user_inbox_preference_enabled — if you are using the Inbox channel, enable this to show the Inbox channel in the preference centre.
sms_vendor_type — SMS delivery mode used for this workspace (basic for standard sends, dlt for India DLT-compliant sends).
user_tenancy_mode — how a user’s association to tenants is constrained. shared allows a user to belong to any number of tenants; exclusive restricts each user to at most one tenant. See User-tenant mapping for the trade-offs.
user_tenancy_channel_fallback_mode and user_tenancy_channel_fallback — govern which channels on a tenant-scoped profile are allowed to fall back to the user’s global profile. Use allowlist mode with an explicit list to prevent identities like $androidpush or $slack from leaking across tenants.
user_tenancy_channel_fallback_applies_to_default_tenant — whether the fallback rule above also applies to the default-tenant path (sends without a tenant_id).

GET

{workspace}

config

Get Workspace Config

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

import requests

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

headers = {"ServiceToken <token>": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ServiceToken <token>", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/config/")
  .header("ServiceToken <token>", "<api-key>")
  .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::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'

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

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

{
  "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).

Response

Workspace config retrieved.

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

Update Workspace ConfigUpdate one or more workspace-level configuration flags. Any field returned by `GET /v1/{workspace}/config/` can be sent in the PATCH body — only fields you include are changed.

⌘I

Get Workspace Config

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

import requests

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

headers = {"ServiceToken <token>": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'ServiceToken <token>': '<api-key>'}};

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 => "GET",
  CURLOPT_HTTPHEADER => [
    "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"
	"net/http"
	"io"
)

func main() {

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

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("ServiceToken <token>", "<api-key>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://management-api.suprsend.com/v1/{workspace}/config/")
  .header("ServiceToken <token>", "<api-key>")
  .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::Get.new(url)
request["ServiceToken <token>"] = '<api-key>'

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

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

{
  "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

Get Workspace Config

Authorizations

Path Parameters

Response