Skip to content
/Partners

Create partner

Request

Provision an inactive partner. Owner email and brand mode are required; invitation and activation are separate.

Security
bearerAuth
Headers
Idempotency-Keystring, [ 1 .. 200 ] charactersrequired

Reuse for an uncertain retry of the same intent.

Bodyapplication/jsonrequired
namestring, [ 1 .. 160 ] charactersrequired
slugstring^[a-z0-9][a-z0-9-]{0,79}$required
owner_emailstring, (email), <= 254 characters^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z...required
owner_namestring, [ 1 .. 160 ] characters
timezonestring, <= 100 charactersrequired
brand_modestringrequired
Enum:"single""hub"
custom_domainstring or null
Any of:
<= 253 characters
string
curl -i -X POST \
  https://api-docs.shuffll.com/_mock/engage/openapi/v1/meta-organizations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: string' \
  -d '{
    "name": "string",
    "slug": "string",
    "owner_email": "user@example.com",
    "owner_name": "string",
    "timezone": "string",
    "brand_mode": "single",
    "custom_domain": "string"
  }'

Responses

Terminal operation job.

Headers
X-Request-Idstring, (uuid)required

Identifier for tracing this response.

Locationstring, (uri)required

Absolute URL of the operation job, from the trusted server origin.

ETagstring

Quoted opaque revision when the resource or job result has one.

Bodyapplication/json
jobobjectrequired
secretAvailablebooleanrequired
Default:false
secretstring
keyobject
Response
{
  "job": {
    "id": "string",
    "command": "string",
    "resourceId": "string",
    "state": "queued",
    "createdAt": "string",
    "updatedAt": "string",
    "result": { … },
    "pollAfterSeconds": 0
  },
  "secretAvailable": false,
  "secret": "string",
  "key": {
    "id": "string",
    "level": "platform",
    "meta_organization_id": "string",
    "organization_id": "string",
    "name": "string",
    "scopes": [ … ],
    "environment": "dev",
    "display_prefix": "string",
    "created_by": "string",
    "issuer_key_id": "string",
    "delegation_allowed": true,
    "created_at": "string",
    "expires_at": "string",
    "revoked_at": "string",
    "last_used_at": "string",
    "revision": "string"
  }
}