SparQDocs
GuidesAPI referencesparqhq.ai
API referenceTenancy

Update Audience Tenant

PATCH
/v1/admin/audience-tenants/{audience_tenant_id}

Not available yet. This operation is part of the published contract and answers 501 not_implemented until it is built. The request and response shapes below are final for this contract version.

Authorization

HTTPBearer
headerAuthorizationBearer <token>

Bearer credential. API keys look like sqk_<geo>_<key_id>_<secret>: treat them as opaque and never put one in a browser. Older keys without the geo part stay valid until rotated. Find a geo's endpoints through GET /.well-known/sparq-discovery before sending a key.

Path Parameters

audience_tenant_id*Audience Tenant Id
Formatuuid

Header Parameters

Sparq-Workspace?string

For a person signed in to a console with several workspaces: the workspace this call is for, one of their memberships (listMyMemberships). Without it such a person gets workspace_required (400); a workspace they are not a member of is forbidden. It never grants anything, and other callers' credentials ignore it.

Formatuuid
If-Match?string

The ETag you last read. A different current version is precondition_failed (412). Optional in 0.5.0.

Request Body

application/json
  1. body

PATCH /v1/admin/audience-tenants/{audience_tenant_id}.

Suspension is the lasting state and is refused at sign-in; a kill switch on the client is the emergency stop for running work (agreed 27 Oct 2026).

name?|null
status?|null

Response Body

Successful Response

application/json
  1. response

A customer of the host application, or the project's own reserved tenant.

audience_tenant_id*Audience Tenant Id
Formatuuid
project_id*Project Id
Formatuuid
kind*Kind

'project' marks the one reserved tenant each project has; it has no external_id and cannot be created or deleted through the API.

Value in"customer""project"
external_id*|

The host's identifier; empty for 'project'.

name*Name
status*Status
Value in"active""suspended"
created_at*Created At
Formatdate-time
region?|

Where the client's data lives.

Example Request
curl -X PATCH 'http://dev-sparq.centralindia.cloudapp.azure.com:8000/v1/admin/audience-tenants/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "audience_tenant_id": "0287c3f7-886a-49f4-a73e-03577e798c26",  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",  "kind": "customer",  "external_id": "string",  "name": "string",  "status": "active",  "created_at": "2019-08-24T14:15:22Z",  "region": "westeurope"}

List Workspaces GET

Every workspace for an operator; a workspace admin's own workspace otherwise.

Update Environment PATCH

> **Not available yet.** This operation is part of the published contract and answers `501 not_implemented` until it is built. The request and response shapes below are final for this contract version.