Platform & SaaS

Environments & provider apps

Create branded embedded environments, verify custom domains, and isolate provider credentials with bring-your-own apps.

Endpoint summary

All operations in this resource, with the minimum accepted key scope.

Method & endpointPurposeScope

GET/api/environments

List embedded environments

read

POST/api/environments

Create a test or live environment

full

PATCH/api/environments/{id}

Update brand and custom domain

full

POST/api/environments/{id}/verify-domain

Check DNS and provision the hostname

full

GET/api/platform-apps

List tenant-owned provider apps

full

PUT/api/platform-apps/{platform}

Store encrypted provider credentials

full

DELETE/api/platform-apps/{platform}

Delete provider app credentials

full

Create an embedded environment

Environments hold a mode and brand configuration for customer-facing connection experiences. White-label fields include logo, primary color, and custom domain where your plan enables them.

Create live environmentPostGate API

curl -X POST https://postgate.studio/api/environments \
  -H "Authorization: Bearer $POSTGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Connect",
    "mode": "live",
    "brand": { "product_name": "Acme Social" }
  }'

Verify a custom domain

Patch the environment with custom_domain, publish the TXT record returned by the verification endpoint, then call verification again until the hostname is active.

Bring your own provider app

Store provider client credentials for an organization to isolate quotas, approval status, and provider branding. Secrets are encrypted and never returned by list operations.

Configure a Meta appPostGate API

curl -X PUT https://postgate.studio/api/platform-apps/facebook \
  -H "Authorization: Bearer $POSTGATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": "$META_CLIENT_ID",
    "client_secret": "$META_CLIENT_SECRET",
    "quotas": {}
  }'

Capability is deployment and workspace specific

A platform appears in GET /api/platforms only when it is enabled and has usable credentials for the current workspace. Build connection selectors from that response instead of a hard-coded list.

BYO apps are plan-gated

The API returns an explicit entitlement error when white-label or bring-your-own-app features are not enabled for the organization.

Endpoint summary

Create an embedded environment

Verify a custom domain

Bring your own provider app

Capability is deployment and workspace specific

Continue building