absuite-system

name: absuite-system description: > Manage system administration in the Alliance Business Suite (ABS) via the REST API. Covers cross-tenant admin (tenants, users), system/tenant/user/contact options, licensing, system portals, overview, IP lookups, carts, business domains, system emails, migrations and antiforgery — including atomic PATCH (JSON Patch) updates. Most operations require an admin-level bearer token (see the absuite-login skill to authenticate).

Alliance Business Suite — System (REST)

The SystemService is the platform administration surface of the Alliance Business Suite. It exposes cross-tenant admin operations (manage every tenant and every user on the suite instance), key-value options at four scopes (system, tenant, user, contact), licensing (validate / redeem / inspect), system portals, a system overview, IP lookups, carts, business domains, admin email dispatch, database migrations, and antiforgery tokens.

Most of these operations are privileged: they read and write data across the whole instance, so they require an admin-level account. Treat user/tenant deletion and migration as destructive.

For the CLI equivalent of these operations, see absuite-system-cli. For general REST conventions (auth, envelope, paging, JSON Patch), see absuite-rest.

Authentication

1. Obtain a bearer token:

curl -X POST "$ABSUITE_HOST_URL/login" \
  -H "Content-Type: application/json" \
  -d '{"email": "<admin-email>", "password": "<password>"}'

Extract accessToken from the JSON response and export it:

export ABSUITE_ACCESS_TOKEN="<accessToken>"

2. Send it on every request:

-H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

3. Base path: $ABSUITE_HOST_URL/api/v2/SystemService/... (licensing key generation/validation lives under $ABSUITE_HOST_URL/api/Licensing/...).

4. Response envelope — every call returns:

{
  "isSuccess": true,
  "errorMessage": null,
  "correlationId": "...",
  "timestamp": "...",
  "result": <data | array | int | null>
}

Always check isSuccess; read the payload from result.

Tenant scoping (read carefully — it varies per endpoint)

SystemService is mostly an instance-wide admin surface, so scoping is not uniform. Apply exactly what the manifest specifies:

The platform reads tenantId from the ?tenantId= query param or the X-TenantId header interchangeably where it is accepted. Prefer the query param in examples.

Key Concepts

• Option — a key-value setting (key, value) with flags: frozen (read-only/locked), autoload (eager-loaded), transient (not persisted long-term), and expiration (integer TTL). Options exist at four scopes addressed by route: system (/Options), tenant (/Tenants/{tenantId}/Options), user (/Users/{userId}/Options), and contact (/Contacts/{contactId}/Options). All four share the OptionCreateDto / OptionUpdateDto body shape. portalId optionally segments options by portal.
• System option upsert — PUT /Options/Upsert/{key} creates or updates a system option by key (idempotent configuration writes). System options only.
• Tenant (cross-tenant admin) — a full business/org record created with TenantCreateDto (name, email, currencyId, countryId are required). Extended variants return enriched records.
• User (cross-tenant admin, a.k.a. account holder) — created with UserCreateDto. gender ∈ Unknown|Male|Female|PreferNotToSay; on update availability ∈ DND|Busy|Away|Offline|Available.
• License — validated/redeemed by licenseKey. A license has Assignments, Attributes, Features and a records Quota, each readable by licenseId. licenseType (key generation) ∈ Trial|Standard|Enterprise.
• System portal — a web portal record (title, domain, websiteThemeId, businessDomainId, businessPortalApplicationId, root, disabled) created with WebPortalCreateDto.
• Email dispatch — admin email requests carry title, message, culture, uiCulture, and a recipients array (all required), plus optional buttonLink/buttonText, alertMessage, alertType ∈ None|Info|Error|Warning|Success|Action|Alert, and addressing arrays (contactIds, tenantIds, userIds) and template refs (templateUrl, emailTemplateId).
• PATCH = JSON Patch (RFC 6902) — body is a JSON array of operations ({ "op": "replace", "path": "/value", "value": "..." }); see the PATCH section below.

Overview

curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Overview" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Tenants (cross-tenant admin — NO tenantId)

# List all tenants on this suite instance
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Count tenants
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# List extended tenants / count
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/Extended" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/Extended/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get a tenant by ID
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create a tenant
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Name": "<tenant-name>",
        "Email": "<tenant-email>",
        "CurrencyId": "<currency-id>",
        "CountryId": "<country-id>",
        "LegalName": "<legal-name>",
        "Phone": "<phone>",
        "WebUrl": "<web-url>",
        "Handler": "<handler>",
        "LanguageId": "<language-id>",
        "TimezoneId": "<timezone-id>"
      }'

# Update a tenant (full replace)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Name": "<tenant-name>",
        "Email": "<tenant-email>",
        "CurrencyId": "<currency-id>",
        "CountryId": "<country-id>"
      }'

# Delete a tenant (destructive)
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

TenantCreateDto required: name, email, currencyId, countryId. Optional incl. legalName, phone, webUrl, handler, about, slogan, duns, taxId, avatarUrl, stateId, cityId, languageId, timezoneId, businessTypeId, businessSegmentId, businessIndustryId, businessSizeId. TenantUpdateDto required: name, email, currencyId, countryId; adds social/contact fields (twitterUsername, facebookUrl, twitterUrl, gitHubUrl, linkedInUrl, instagramUrl, youTubeUrl, whatsAppNumber, supportPhoneNumber).

Tenant emails (NO tenantId — tenant is the path segment)

# Preview a rendered email for a tenant
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Emails/Preview" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<subject>",
        "Message": "<body>",
        "Culture": "en-US",
        "UiCulture": "en-US",
        "Recipients": ["<recipient-email>"]
      }'

# Send an email to a tenant
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Emails/Send" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<subject>",
        "Message": "<body>",
        "Culture": "en-US",
        "UiCulture": "en-US",
        "Recipients": ["<recipient-email>"],
        "AlertType": "Info"
      }'

Users (cross-tenant admin — NO tenantId)

# List users / count
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# List extended users / count
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/Extended" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/Extended/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get a user by ID / extended by ID
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Extended" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create a user
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Users" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Email": "<user-email>",
        "FirstName": "<first>",
        "LastName": "<last>",
        "Password": "<password>",
        "Gender": "Unknown"
      }'

# Update a user (full replace)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Email": "<user-email>",
        "FirstName": "<first>",
        "LastName": "<last>",
        "Availability": "Available"
      }'

# Delete a user (destructive)
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

UserCreateDto fields (all optional in the schema): qualifiedName, birthday, firstName, lastName, publicName, idProvider, gender (Unknown|Male|Female|PreferNotToSay), email, about, status, jobTitle, social URLs, timezoneId, languageId, currencyId, countryId, stateId, cityId, password. UserUpdateDto adds availability (DND|Busy|Away|Offline|Available) and webUrl.

User emails (NO tenantId — user is the path segment)

curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Emails/Preview" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Title": "<subject>", "Message": "<body>", "Culture": "en-US", "UiCulture": "en-US", "Recipients": ["<recipient-email>"] }'

curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Emails/Send" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Title": "<subject>", "Message": "<body>", "Culture": "en-US", "UiCulture": "en-US", "Recipients": ["<recipient-email>"] }'

System Options (scoped by portalId)

# List options for a portal (portalId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Options?portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Count options for a portal (portalId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Options/Count?portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get an option by ID
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get an option by key (portalId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Options/Key/<key>?portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create an option (key REQUIRED as query param; portalId optional)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Options?key=<key>&portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Key": "<key>",
        "Value": "<value>",
        "PortalId": "<portal-guid>",
        "Frozen": false,
        "Autoload": false,
        "Transient": false,
        "Expiration": 0
      }'

# Update an option (full replace)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

# Upsert an option by key (create or update; portalId optional)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Options/Upsert/<key>?portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

# Delete an option
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

OptionCreateDto required: key, value. Optional: id, timestamp, portalId, frozen, autoload, transient, expiration. OptionUpdateDto omits id/timestamp.

Tenant Options (admin — tenant is the path segment)

# List / count options for a tenant (portalId optional filter)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get a single tenant option
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create a tenant option (key REQUIRED as query param; portalId optional)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options?key=<key>&portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

# Update a tenant option (full replace)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

# Delete a tenant option
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

User Options (admin — user is the path segment)

curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create (key REQUIRED as query param; portalId optional)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options?key=<key>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Users/<user-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Contact Options (admin — contact is the path segment)

curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create (key REQUIRED as query param; portalId optional)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options?key=<key>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "<key>", "Value": "<value>" }'

curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Contacts/<contact-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Licensing

# List licenses (tenantId OPTIONAL — pass it to scope to a tenant)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get a license by ID (tenantId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/<license-guid>?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# License sub-resources (tenantId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/<license-guid>/Assignments?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/<license-guid>/Attributes?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/<license-guid>/Features?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/<license-guid>/Quota?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Validate a license (NO tenantId)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/Validate" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "licenseKey": "<license-key>" }'

# Redeem a license (tenantId REQUIRED)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Licensing/Licenses/Redeem?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "licenseKey": "<license-key>" }'

LicenseValidationRequest required field: licenseKey.

Licensing key API (/api/Licensing/... — tenantId REQUIRED on all)

# Generate a license key
curl -X POST "$ABSUITE_HOST_URL/api/Licensing/Licenses/Generate?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "tenantId": "<tenant-guid>",
        "userId": "<user-guid>",
        "seats": 5,
        "licenseType": "Standard"
      }'

# Validate a license key (key in body)
curl -X GET "$ABSUITE_HOST_URL/api/Licensing/Licenses/Validate?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "key": "<license-key>" }'

# Validate — attributes / errors
curl -X GET "$ABSUITE_HOST_URL/api/Licensing/Licenses/Validate/Attributes?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" -d '{ "key": "<license-key>" }'
curl -X GET "$ABSUITE_HOST_URL/api/Licensing/Licenses/Validate/Errors?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" -d '{ "key": "<license-key>" }'

LicenseKeyRequest optional fields: userId, tenantId, orderId, paymentId, invoiceId, enrollmentId, entitlementId, seats, licenseType (Trial|Standard|Enterprise), expirationDate, features, additionalAttributes. LicenseKey body field: key.

System Portals

# List / count
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Portals" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Portals/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get by ID
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Portals/<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Create
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Portals" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<portal-title>",
        "Domain": "<portal-domain>",
        "Root": false,
        "Disabled": false,
        "Description": "<description>",
        "WebsiteThemeId": "<theme-guid>",
        "BusinessDomainId": "<business-domain-guid>",
        "BusinessPortalApplicationId": "<app-guid>"
      }'

# Update (full replace)
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Portals/<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<portal-title>",
        "Domain": "<portal-domain>",
        "Disabled": false
      }'

# Delete
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Portals/<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

WebPortalCreateDto fields: id, timestamp, root, title, domain, disabled, description, websiteThemeId, businessDomainId, businessPortalApplicationId. WebPortalUpdateDto omits id/timestamp.

Business Domains

# List / count
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/BusinessDomains" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/BusinessDomains/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Get by ID
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/BusinessDomains/<business-domain-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Verify a business domain (action)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/BusinessDomains/<business-domain-guid>/Verify" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Delete
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/BusinessDomains/<business-domain-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

IP Lookups

curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/IPLookups" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/IPLookups/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/IPLookups/<ip-lookup-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/IPLookups/<ip-lookup-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Carts

curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Carts" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Carts/Count" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Carts/<cart-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"
curl -X DELETE "$ABSUITE_HOST_URL/api/v2/SystemService/Carts/<cart-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Modules

# All modules on this suite server instance (tenantId REQUIRED)
curl -X GET "$ABSUITE_HOST_URL/api/v2/StudioService/Modules?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Modules available to a tenant user (tenantId OPTIONAL)
curl -X GET "$ABSUITE_HOST_URL/api/v2/StudioService/Modules/Data?tenantId=<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Note: the Modules operations are published under the /api/v2/StudioService/ base in the SystemService OpenAPI spec (confirmed in the generated SDK), so they are addressed with StudioService, not SystemService.

System Emails (basic, instance-level)

# Preview a rendered basic email template
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Emails/Preview" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<subject>",
        "Message": "<body>",
        "Culture": "en-US",
        "UiCulture": "en-US",
        "Recipients": ["<recipient-email>"]
      }'

# Send a basic transactional email
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Emails/SendBasic" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
        "Title": "<subject>",
        "Message": "<body>",
        "Culture": "en-US",
        "UiCulture": "en-US",
        "Recipients": ["<recipient-email>"],
        "AlertType": "Info",
        "ButtonText": "<cta-label>",
        "ButtonLink": "<cta-url>"
      }'

Email body required fields: title, message, culture, uiCulture, recipients. Optional: buttonLink, buttonText, alertMessage, alertType (None|Info|Error|Warning|Success|Action|Alert), contactIds, tenantIds, userIds, templateUrl, emailTemplateId, payload.

Migrations

# List migrations (pending=true to list only pending)
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Migrations?pending=true" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Apply pending migrations (destructive — use with caution in production)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Migrations/Migrate" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

Antiforgery

# Get and store antiforgery tokens
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Antiforgery/GetAndStoreTokens" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

# Validate the antiforgery request
curl -X GET "$ABSUITE_HOST_URL/api/v2/SystemService/Antiforgery/IsRequestValid" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN"

PATCH (JSON Patch — RFC 6902)

PATCH bodies are a JSON array of operations: op ∈ add|remove|replace|move|copy|test; path/from are JSON Pointers (leading /, camelCase field). Use PATCH for atomic partial updates — change a couple of fields without resending the whole object.

In SystemService, seven resources support PATCH:

Example — flip a system option's value and lock it (no tenantId; option scope addressed by ID/portal):

curl -X PATCH "$ABSUITE_HOST_URL/api/v2/SystemService/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
        { "op": "replace", "path": "/value", "value": "true" },
        { "op": "replace", "path": "/frozen", "value": true }
      ]'

Example — rename a tenant and update its support phone (cross-tenant admin — NO tenantId):

curl -X PATCH "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[
        { "op": "replace", "path": "/name", "value": "<new-name>" },
        { "op": "replace", "path": "/supportPhoneNumber", "value": "<phone>" }
      ]'

Example — disable a system portal:

curl -X PATCH "$ABSUITE_HOST_URL/api/v2/SystemService/Portals/<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[ { "op": "replace", "path": "/disabled", "value": true } ]'

End-to-end workflow: provision a tenant with a portal and a config option

# 1. Create a tenant (cross-tenant admin — no tenantId)
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Name": "<tenant-name>", "Email": "<tenant-email>", "CurrencyId": "<currency-id>", "CountryId": "<country-id>" }'
# -> capture result.id as <tenant-guid>

# 2. Create a system portal for it
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Portals" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Title": "<portal-title>", "Domain": "<portal-domain>", "Root": false, "Disabled": false }'
# -> capture result.id as <portal-guid>

# 3. Upsert a system option scoped to that portal
curl -X PUT "$ABSUITE_HOST_URL/api/v2/SystemService/Options/Upsert/app.maintenance-mode?portalId=<portal-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "app.maintenance-mode", "Value": "false" }'

# 4. Add a tenant-scoped option
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options?key=onboarding.completed" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Key": "onboarding.completed", "Value": "false" }'
# -> capture result.id as <option-guid>

# 5. Atomically flip the tenant option once onboarding finishes (PATCH)
curl -X PATCH "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Options/<option-guid>" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '[ { "op": "replace", "path": "/value", "value": "true" } ]'

# 6. Send the tenant a welcome email
curl -X POST "$ABSUITE_HOST_URL/api/v2/SystemService/Tenants/<tenant-guid>/Emails/Send" \
  -H "Authorization: Bearer $ABSUITE_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "Title": "Welcome", "Message": "Your workspace is ready.", "Culture": "en-US", "UiCulture": "en-US", "Recipients": ["<tenant-email>"], "AlertType": "Success" }'

API Endpoints Quick Reference

Critical Rules

• Admin access required for most system operations.
• Cross-tenant admin endpoints (/Tenants, /Users and their /Emails) take NO tenantId — they act across the whole suite instance. Do not append ?tenantId= or send X-TenantId.
• Options scope by route, not by tenantId query — tenant/user/contact is the path segment; system options scope by portalId.
• Tenant/user/option/portal deletion is destructive. Migrations/Migrate mutates the database — use with caution in production.
• Versioning is additive — api-version / x-api-version are optional; omit unless you need a pinned revision.