{ "openapi": "3.1.0", "info": { "title": "Engage API", "version": "1.0.0", "description": "V1 operation reference for Shuffll Engage. The flat-video-v1 campaign rendering format uses fixed clips; that format-specific restriction does not describe the full Engage product. Discover live workspace capabilities and the MCP tool catalog for available workflows. Access is checked against tenant policy and principal authority." }, "servers": [ { "url": "https://engage.shuffll.com/api" } ], "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "paths": { "/v1/meta-organizations": { "post": { "operationId": "partners_provision", "summary": "Create partner", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "meta-organizations:provision", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": true, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "partner_provision", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "slug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,79}$" }, "owner_email": { "type": "string", "maxLength": 254, "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "owner_name": { "type": "string", "minLength": 1, "maxLength": 160 }, "timezone": { "type": "string", "maxLength": 100 }, "brand_mode": { "type": "string", "enum": [ "single", "hub" ] }, "custom_domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ] } }, "required": [ "name", "slug", "owner_email", "timezone", "brand_mode" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Provision an inactive partner. Owner email and brand mode are required; invitation and activation are separate.", "tags": [ "Partners" ], "x-seo": { "title": "Create partner — Shuffll Engage API", "description": "Shuffll Engage: Provision an inactive partner." } }, "get": { "operationId": "partners_list", "summary": "List partners", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "meta-organizations:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": true, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brand_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "provisioning": { "type": "string", "enum": [ "ready", "provisioning", "recovery_required", "unmanaged" ] }, "activation": { "type": "object", "properties": { "ready": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string" } } }, "required": [ "ready", "missing" ], "additionalProperties": false } }, "required": [ "id", "name", "slug", "is_active", "custom_domain", "timezone", "brand_mode", "revision", "provisioning", "activation" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List safe partner metadata with cursor pagination.", "tags": [ "Partners" ], "x-seo": { "title": "List partners — Shuffll Engage API", "description": "Shuffll Engage: List safe partner metadata with cursor pagination." } } }, "/v1/meta-organizations/{id}": { "get": { "operationId": "partners_get", "summary": "Get partner", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "meta-organizations:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": true, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brand_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "provisioning": { "type": "string", "enum": [ "ready", "provisioning", "recovery_required", "unmanaged" ] }, "activation": { "type": "object", "properties": { "ready": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string" } } }, "required": [ "ready", "missing" ], "additionalProperties": false } }, "required": [ "id", "name", "slug", "is_active", "custom_domain", "timezone", "brand_mode", "revision", "provisioning", "activation" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read safe partner provisioning and activation status.", "tags": [ "Partners" ], "x-seo": { "title": "Get partner — Shuffll Engage API", "description": "Shuffll Engage: Read safe partner provisioning and activation status." } }, "patch": { "operationId": "partners_update", "summary": "Update partner", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "meta-organizations:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": true, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "partner_update", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "custom_domain": { "anyOf": [ { "type": "string", "maxLength": 253 }, { "type": "null" } ] }, "timezone": { "type": "string", "maxLength": 100 } }, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Update partner metadata. Custom domain remains metadata only.", "tags": [ "Partners" ], "x-seo": { "title": "Update partner — Shuffll Engage API", "description": "Shuffll Engage: Update partner metadata." } } }, "/v1/meta-organizations/{id}/activation": { "post": { "operationId": "partners_activate", "summary": "Set activation", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "meta-organizations:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": true, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "partner_update", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "is_active": { "type": "boolean" } }, "required": [ "is_active" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Explicitly activate or deactivate a partner using existing readiness prerequisites.", "tags": [ "Partners" ], "x-seo": { "title": "Set activation — Shuffll Engage API", "description": "Shuffll Engage: Explicitly activate or deactivate a partner using existing readiness prerequisites." } } }, "/v1/account": { "get": { "operationId": "account_get", "summary": "Get current account", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": true, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "custom_domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "timezone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "brand_mode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "provisioning": { "type": "string", "enum": [ "ready", "provisioning", "recovery_required", "unmanaged" ] }, "activation": { "type": "object", "properties": { "ready": { "type": "boolean" }, "missing": { "type": "array", "items": { "type": "string" } } }, "required": [ "ready", "missing" ], "additionalProperties": false } }, "required": [ "id", "name", "slug", "is_active", "custom_domain", "timezone", "brand_mode", "revision", "provisioning", "activation" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read the current partner account for a partner-level principal.", "tags": [ "Partners" ], "x-seo": { "title": "Get current account — Shuffll Engage API", "description": "Shuffll Engage: Read the current partner account for a partner-level principal." } } }, "/v1/organizations": { "post": { "operationId": "organizations_create", "summary": "Create organization", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": true, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "organization_write", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "slug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,79}$" } }, "required": [ "name", "slug" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Create a child organization and its brand profile.", "tags": [ "Organizations" ], "x-seo": { "title": "Create organization — Shuffll Engage API", "description": "Shuffll Engage: Create a child organization and its brand profile." } }, "get": { "operationId": "organizations_list", "summary": "List organizations", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "is_default": { "type": "boolean" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "favicon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "meta_organization_id", "name", "slug", "is_active", "is_default", "revision", "logo_url", "favicon_url", "primary_color", "secondary_color", "accent_color", "font_family" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List only organizations within the current tenant context.", "tags": [ "Organizations" ], "x-seo": { "title": "List organizations — Shuffll Engage API", "description": "Shuffll Engage: List only organizations within the current tenant context." } } }, "/v1/organizations/{id}": { "get": { "operationId": "organizations_get", "summary": "Get organization", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "slug": { "type": "string" }, "is_active": { "type": "boolean" }, "is_default": { "type": "boolean" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "favicon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "meta_organization_id", "name", "slug", "is_active", "is_default", "revision", "logo_url", "favicon_url", "primary_color", "secondary_color", "accent_color", "font_family" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read safe organization metadata and revision.", "tags": [ "Organizations" ], "x-seo": { "title": "Get organization — Shuffll Engage API", "description": "Shuffll Engage: Read safe organization metadata and revision." } }, "patch": { "operationId": "organizations_update", "summary": "Update organization", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "organization_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "slug": { "type": "string", "pattern": "^[a-z0-9][a-z0-9-]{0,79}$" } }, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Update organization name and slug with a current revision.", "tags": [ "Organizations" ], "x-seo": { "title": "Update organization — Shuffll Engage API", "description": "Shuffll Engage: Update organization name and slug with a current revision." } } }, "/v1/organizations/{id}/archive": { "post": { "operationId": "organizations_archive", "summary": "Archive organization", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "organizations:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "organization_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Archive a non-default organization. Its history is retained.", "tags": [ "Organizations" ], "x-seo": { "title": "Archive organization — Shuffll Engage API", "description": "Shuffll Engage: Archive a non-default organization." } } }, "/v1/organizations/{id}/branding": { "get": { "operationId": "branding_get", "summary": "Get branding", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "brands:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "logo_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "favicon_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "primary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "accent_color": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "font_family": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "revision", "logo_url", "favicon_url", "primary_color", "secondary_color", "accent_color", "font_family" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read the organization brand profile.", "tags": [ "Branding" ], "x-seo": { "title": "Get branding — Shuffll Engage API", "description": "Shuffll Engage: Read the organization brand profile." } }, "patch": { "operationId": "branding_update", "summary": "Update branding", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "brands:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "organization_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "logo_asset_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "favicon_asset_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "primary_color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" }, { "type": "null" } ] }, "secondary_color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" }, { "type": "null" } ] }, "accent_color": { "anyOf": [ { "type": "string", "pattern": "^#[0-9a-fA-F]{6}$" }, { "type": "null" } ] }, "font_family": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 120, "pattern": "^[\\p{L}\\p{N} ,'-]+$" }, { "type": "null" } ] } }, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Update brand colors, font and verified owned image assets.", "tags": [ "Branding" ], "x-seo": { "title": "Update branding — Shuffll Engage API", "description": "Shuffll Engage: Update brand colors, font and verified owned image assets." } } }, "/v1/organizations/{id}/members": { "get": { "operationId": "members_list", "summary": "List members", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "user_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "role": { "type": "string", "enum": [ "org_admin", "user" ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "user_id", "organization_id", "role", "revision" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List organization memberships.", "tags": [ "Members" ], "x-seo": { "title": "List members — Shuffll Engage API", "description": "Shuffll Engage: List organization memberships." } }, "post": { "operationId": "members_add", "summary": "Add member", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "membership_write", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string", "enum": [ "org_admin", "user" ] } }, "required": [ "email", "role" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Add an existing account without sending an invitation.", "tags": [ "Members" ], "x-seo": { "title": "Add member — Shuffll Engage API", "description": "Shuffll Engage: Add an existing account without sending an invitation." } } }, "/v1/organizations/{id}/members/{member_id}": { "patch": { "operationId": "members_update", "summary": "Update member role", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "membership_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "role": { "type": "string", "enum": [ "org_admin", "user" ] } }, "required": [ "role" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Change a membership role while protecting the last administrator.", "tags": [ "Members" ], "x-seo": { "title": "Update member role — Shuffll Engage API", "description": "Shuffll Engage: Change a membership role while protecting the last administrator." } }, "delete": { "operationId": "members_remove", "summary": "Remove member", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "membership_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "member_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Remove a membership while protecting the last administrator.", "tags": [ "Members" ], "x-seo": { "title": "Remove member — Shuffll Engage API", "description": "Shuffll Engage: Remove a membership while protecting the last administrator." } } }, "/v1/organizations/{id}/invitations": { "post": { "operationId": "invitations_create", "summary": "Create invitation", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "invitation_send", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "email": { "type": "string" }, "role": { "type": "string", "enum": [ "org_admin", "user" ] } }, "required": [ "email", "role" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Explicitly invite an account. Membership begins only after acceptance.", "tags": [ "Invitations" ], "x-seo": { "title": "Create invitation — Shuffll Engage API", "description": "Shuffll Engage: Explicitly invite an account." } }, "get": { "operationId": "invitations_list", "summary": "List invitations", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "org_admin", "user" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked" ] }, "delivery": { "type": "string", "enum": [ "queued", "sending", "sent", "failed", "recovery_required" ] }, "expires_at": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "organization_id", "email", "role", "status", "delivery", "expires_at", "revision" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List scoped invitation status.", "tags": [ "Invitations" ], "x-seo": { "title": "List invitations — Shuffll Engage API", "description": "Shuffll Engage: List scoped invitation status." } } }, "/v1/organizations/{id}/invitations/{invitation_id}": { "get": { "operationId": "invitations_get", "summary": "Get invitation", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "email": { "type": "string" }, "role": { "type": "string", "enum": [ "org_admin", "user" ] }, "status": { "type": "string", "enum": [ "pending", "accepted", "revoked" ] }, "delivery": { "type": "string", "enum": [ "queued", "sending", "sent", "failed", "recovery_required" ] }, "expires_at": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "organization_id", "email", "role", "status", "delivery", "expires_at", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read an invitation without sending mail.", "tags": [ "Invitations" ], "x-seo": { "title": "Get invitation — Shuffll Engage API", "description": "Shuffll Engage: Read an invitation without sending mail." } }, "delete": { "operationId": "invitations_revoke", "summary": "Revoke invitation", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "membership_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Revoke a pending invitation.", "tags": [ "Invitations" ], "x-seo": { "title": "Revoke invitation — Shuffll Engage API", "description": "Shuffll Engage: Revoke a pending invitation." } } }, "/v1/organizations/{id}/invitations/{invitation_id}/resend": { "post": { "operationId": "invitations_resend", "summary": "Resend invitation", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "members:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "invitation_send", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "invitation_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Explicitly resend an invitation with a known prior delivery outcome.", "tags": [ "Invitations" ], "x-seo": { "title": "Resend invitation — Shuffll Engage API", "description": "Shuffll Engage: Explicitly resend an invitation with a known prior delivery outcome." } } }, "/v1/organizations/{id}/access": { "get": { "operationId": "organization_access_get", "summary": "Get organization access", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "api-access:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": true, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "enabled": { "type": "boolean" }, "scopes": { "maxItems": 100, "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "delegationAllowed": { "default": false, "type": "boolean" }, "selfService": { "default": false, "type": "boolean" }, "readPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "mutationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "generationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "activeGenerations": { "type": "integer", "minimum": 1, "maximum": 10000 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "enabled", "scopes", "delegationAllowed", "selfService", "id", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read child access settings as a partner administrator.", "tags": [ "Access policies" ], "x-seo": { "title": "Get organization access — Shuffll Engage API", "description": "Shuffll Engage: Read child access settings as a partner administrator." } }, "put": { "operationId": "organization_access_set", "summary": "Set organization access", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "api-access:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": true, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "access_policy", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "enabled": { "type": "boolean" }, "scopes": { "maxItems": 100, "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "delegationAllowed": { "default": false, "type": "boolean" }, "selfService": { "default": false, "type": "boolean" }, "readPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "mutationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "generationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "activeGenerations": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "enabled", "scopes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Delegate API access within current partner entitlements.", "tags": [ "Access policies" ], "x-seo": { "title": "Set organization access — Shuffll Engage API", "description": "Shuffll Engage: Delegate API access within current partner entitlements." } } }, "/v1/uploads": { "post": { "operationId": "uploads_create", "summary": "Create upload", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "asset_write", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "media_type": { "type": "string", "enum": [ "image/png", "image/jpeg", "image/webp" ] }, "size": { "type": "integer", "minimum": 1, "maximum": 10485760 } }, "required": [ "media_type", "size" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "upload": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "pending", "ready", "revoked", "expired" ] }, "media_type": { "type": "string", "enum": [ "image/png", "image/jpeg", "image/webp" ] }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "finalize_before": { "type": "string" }, "upload_capability_validity_seconds": { "type": "number", "const": 7200 }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "status", "media_type", "size", "finalize_before", "upload_capability_validity_seconds", "revision" ], "additionalProperties": false }, "capability": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "const": "PUT" }, "content_type": { "type": "string" }, "issued_at": { "type": "string" }, "validity_seconds": { "type": "number", "const": 7200 } }, "required": [ "url", "method", "content_type", "issued_at", "validity_seconds" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "job", "upload", "capability" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "upload": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "pending", "ready", "revoked", "expired" ] }, "media_type": { "type": "string", "enum": [ "image/png", "image/jpeg", "image/webp" ] }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "finalize_before": { "type": "string" }, "upload_capability_validity_seconds": { "type": "number", "const": 7200 }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "status", "media_type", "size", "finalize_before", "upload_capability_validity_seconds", "revision" ], "additionalProperties": false }, "capability": { "anyOf": [ { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "method": { "type": "string", "const": "PUT" }, "content_type": { "type": "string" }, "issued_at": { "type": "string" }, "validity_seconds": { "type": "number", "const": 7200 } }, "required": [ "url", "method", "content_type", "issued_at", "validity_seconds" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "job", "upload", "capability" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Create a private PNG/JPEG/WebP upload (1–10485760 bytes). Finalize within 15 minutes; signed PUT capability lasts 2 hours and cannot overwrite. No remote URL ingestion.", "tags": [ "Uploads" ], "x-seo": { "title": "Create upload — Shuffll Engage API", "description": "Shuffll Engage: Create a private PNG/JPEG/WebP upload (1–10485760 bytes)." } } }, "/v1/uploads/{id}": { "get": { "operationId": "uploads_get", "summary": "Get upload", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "pending", "ready", "revoked", "expired" ] }, "media_type": { "type": "string", "enum": [ "image/png", "image/jpeg", "image/webp" ] }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "finalize_before": { "type": "string" }, "upload_capability_validity_seconds": { "type": "number", "const": 7200 }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "status", "media_type", "size", "finalize_before", "upload_capability_validity_seconds", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read upload status and finalization deadline. Revocation/expiry blocks finalization but does not revoke an already issued 2-hour storage capability.", "tags": [ "Uploads" ], "x-seo": { "title": "Get upload — Shuffll Engage API", "description": "Shuffll Engage: Read upload status and finalization deadline." } }, "delete": { "operationId": "uploads_revoke", "summary": "Revoke upload", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "asset_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Revoke an unfinished upload session. Existing storage PUT capability still lasts up to 2 hours; finalization is denied.", "tags": [ "Uploads" ], "x-seo": { "title": "Revoke upload — Shuffll Engage API", "description": "Shuffll Engage: Revoke an unfinished upload session." } } }, "/v1/uploads/{id}/finalize": { "post": { "operationId": "uploads_finalize", "summary": "Finalize upload", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "asset_write", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Verify completed owned object size, raster bytes and MIME, then atomically create a private ready asset.", "tags": [ "Uploads" ], "x-seo": { "title": "Finalize upload — Shuffll Engage API", "description": "Shuffll Engage: Verify completed owned object size, raster bytes and MIME, then atomically create a private ready asset." } } }, "/v1/assets/{id}": { "get": { "operationId": "assets_get", "summary": "Get asset", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "rejected" ] }, "media_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "meta_organization_id", "organization_id", "status", "media_type", "size", "public_url", "verified_at", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read safe owned asset metadata. Private storage references and upload capabilities are never returned.", "tags": [ "Assets" ], "x-seo": { "title": "Get asset — Shuffll Engage API", "description": "Shuffll Engage: Read safe owned asset metadata." } } }, "/v1/assets": { "get": { "operationId": "assets_list", "summary": "List assets", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "pending", "ready", "rejected" ] }, "media_type": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "size": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "public_url": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "verified_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "meta_organization_id", "organization_id", "status", "media_type", "size", "public_url", "verified_at", "revision" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List owned asset metadata within the current tenant.", "tags": [ "Assets" ], "x-seo": { "title": "List assets — Shuffll Engage API", "description": "Shuffll Engage: List owned asset metadata within the current tenant." } } }, "/v1/assets/{id}/promote-branding": { "post": { "operationId": "assets_promote_branding", "summary": "Publish branding image", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "asset_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Explicitly publish a verified owned raster image at a durable public branding URL. The original storage object remains private.", "tags": [ "Assets" ], "x-seo": { "title": "Publish branding image — Shuffll Engage API", "description": "Shuffll Engage: Explicitly publish a verified owned raster image at a durable public branding URL." } } }, "/v1/catalogs/languages": { "get": { "operationId": "catalogs_languages", "summary": "List languages", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 256 } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read configured languages available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List languages — Shuffll Engage API", "description": "Shuffll Engage: Read configured languages available to this tenant." } } }, "/v1/catalogs/voices": { "get": { "operationId": "catalogs_voices", "summary": "List voices", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read configured voices available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List voices — Shuffll Engage API", "description": "Shuffll Engage: Read configured voices available to this tenant." } } }, "/v1/catalogs/fonts": { "get": { "operationId": "catalogs_fonts", "summary": "List fonts", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 256 } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read configured fonts available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List fonts — Shuffll Engage API", "description": "Shuffll Engage: Read configured fonts available to this tenant." } } }, "/v1/catalogs/music": { "get": { "operationId": "catalogs_music", "summary": "List music", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read configured music available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List music — Shuffll Engage API", "description": "Shuffll Engage: Read configured music available to this tenant." } } }, "/v1/catalogs/models": { "get": { "operationId": "catalogs_models", "summary": "List models", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 256 } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read configured models available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List models — Shuffll Engage API", "description": "Shuffll Engage: Read configured models available to this tenant." } } }, "/v1/catalogs/transitions": { "get": { "operationId": "catalogs_transitions", "summary": "List transitions", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "assets:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "minLength": 1, "maxLength": 256 } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "minLength": 1, "maxLength": 256 }, "name": { "type": "string" }, "native_name": { "type": "string" }, "provider": { "type": "string" }, "family": { "type": "string" }, "kind": { "type": "string", "enum": [ "image", "video" ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 256 }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Native transition styles with verified playback/export parity. Currently empty; generated transitions are never offered. Stable ID cursor pagination defaults to 50 entries, maximum 100.", "tags": [ "Catalogs" ], "x-seo": { "title": "List transitions — Shuffll Engage API", "description": "Shuffll Engage: Native transition styles with verified playback/export parity." } } }, "/v1/templates": { "get": { "operationId": "templates_list", "summary": "List templates", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "templates:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "category": { "type": "string" }, "lang": { "type": "string" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "last_published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "render_source_status": { "type": "string", "enum": [ "unavailable", "ready" ] }, "render_source_format": { "anyOf": [ { "type": "string", "const": "flat-video-v1" }, { "type": "null" } ] }, "render_source_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "lang", "meta_organization_id", "organization_id", "last_published_at", "render_source_status" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable.", "tags": [ "Templates" ], "x-seo": { "title": "List templates — Shuffll Engage API", "description": "Shuffll Engage: Discover authorized published template metadata." } } }, "/v1/templates/{id}": { "get": { "operationId": "templates_get", "summary": "Get template", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "templates:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "category": { "type": "string" }, "lang": { "type": "string" }, "meta_organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "last_published_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "render_source_status": { "type": "string", "enum": [ "unavailable", "ready" ] }, "render_source_format": { "anyOf": [ { "type": "string", "const": "flat-video-v1" }, { "type": "null" } ] }, "render_source_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "name", "category", "lang", "meta_organization_id", "organization_id", "last_published_at", "render_source_status" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable.", "tags": [ "Templates" ], "x-seo": { "title": "Get template — Shuffll Engage API", "description": "Shuffll Engage: Discover authorized published template metadata." } } }, "/v1/templates/{id}/versions": { "get": { "operationId": "template_versions_list", "summary": "List versions", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "templates:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "version_number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "change_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "published_at": { "type": "string" }, "actor_kind": { "type": "string", "enum": [ "user", "api_key", "unknown" ] }, "render_source_status": { "type": "string", "enum": [ "unavailable", "ready" ] }, "render_source_format": { "anyOf": [ { "type": "string", "const": "flat-video-v1" }, { "type": "null" } ] }, "render_source_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "template_id", "version_number", "name", "change_note", "published_at", "actor_kind", "render_source_status" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable.", "tags": [ "Templates" ], "x-seo": { "title": "List versions — Shuffll Engage API", "description": "Shuffll Engage: Discover authorized published template metadata." } } }, "/v1/templates/{id}/versions/{version_id}": { "get": { "operationId": "template_versions_get", "summary": "Get version", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "templates:read", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "version_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "version_number": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "change_note": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "published_at": { "type": "string" }, "actor_kind": { "type": "string", "enum": [ "user", "api_key", "unknown" ] }, "render_source_status": { "type": "string", "enum": [ "unavailable", "ready" ] }, "render_source_format": { "anyOf": [ { "type": "string", "const": "flat-video-v1" }, { "type": "null" } ] }, "render_source_reason": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "id", "template_id", "version_number", "name", "change_note", "published_at", "actor_kind", "render_source_status" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable.", "tags": [ "Templates" ], "x-seo": { "title": "Get version — Shuffll Engage API", "description": "Shuffll Engage: Discover authorized published template metadata." } } }, "/v1/campaigns": { "post": { "operationId": "campaigns_create", "summary": "Create campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_version_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "organization_id", "template_id", "template_version_id", "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Create campaign — Shuffll Engage API", "description": "Create an Engage campaign from an authorized frozen template version. Generation starts through a separate explicit operation." } }, "get": { "operationId": "campaigns_list", "summary": "List campaigns", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_version_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "production_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "archived_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaign_to_send": { "type": "boolean", "const": false }, "auto_export_recipients": { "type": "boolean", "const": false }, "workspace_status": { "type": "string", "enum": [ "pending", "dispatching", "ready", "recovery_required" ] }, "format": { "type": "string", "const": "flat-video-v1" }, "personalization": { "type": "boolean", "const": false }, "created_at": { "type": "string" } }, "required": [ "id", "organization_id", "template_id", "template_version_id", "production_id", "name", "revision", "archived_at", "campaign_to_send", "auto_export_recipients", "workspace_status", "format", "personalization", "created_at" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "List campaigns — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}": { "patch": { "operationId": "campaigns_update", "summary": "Update campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Update campaign — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } }, "get": { "operationId": "campaigns_get", "summary": "Get campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "organization_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "template_version_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "production_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "name": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "archived_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaign_to_send": { "type": "boolean", "const": false }, "auto_export_recipients": { "type": "boolean", "const": false }, "workspace_status": { "type": "string", "enum": [ "pending", "dispatching", "ready", "recovery_required" ] }, "format": { "type": "string", "const": "flat-video-v1" }, "personalization": { "type": "boolean", "const": false }, "created_at": { "type": "string" } }, "required": [ "id", "organization_id", "template_id", "template_version_id", "production_id", "name", "revision", "archived_at", "campaign_to_send", "auto_export_recipients", "workspace_status", "format", "personalization", "created_at" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Get campaign — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}/clone": { "post": { "operationId": "campaigns_clone", "summary": "Clone campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 } }, "required": [ "name" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Clone campaign — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}/archive": { "post": { "operationId": "campaigns_archive", "summary": "Archive campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": {}, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Archive campaign — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}/production": { "patch": { "operationId": "campaign_production_update", "summary": "Update production settings", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "scenes": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "trim_start_ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trim_end_ms": { "type": "integer", "exclusiveMinimum": 0, "maximum": 60000 }, "muted": { "type": "boolean" } }, "required": [ "id", "trim_start_ms", "trim_end_ms", "muted" ], "additionalProperties": false } } }, "required": [ "scenes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Production settings" ], "x-seo": { "title": "Update production settings — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } }, "get": { "operationId": "campaign_production_get", "summary": "Get production settings", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "format": { "type": "string", "const": "flat-video-v1" }, "personalization": { "type": "boolean", "const": false }, "scenes": { "minItems": 1, "maxItems": 5, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "trim_start_ms": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "trim_end_ms": { "type": "integer", "exclusiveMinimum": 0, "maximum": 60000 }, "muted": { "type": "boolean" }, "duration_ms": { "type": "number", "exclusiveMinimum": 0 } }, "required": [ "id", "trim_start_ms", "trim_end_ms", "muted", "duration_ms" ], "additionalProperties": false } }, "capabilities": { "type": "object", "properties": { "trim": { "type": "boolean", "const": true }, "mute": { "type": "boolean", "const": true }, "personalization": { "type": "boolean", "const": false }, "branding_in_video": { "type": "boolean", "const": false }, "transitions": { "type": "array", "items": { "not": {} } } }, "required": [ "trim", "mute", "personalization", "branding_in_video", "transitions" ], "additionalProperties": false } }, "required": [ "id", "campaign_id", "revision", "format", "personalization", "scenes", "capabilities" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Production settings" ], "x-seo": { "title": "Get production settings — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}/validate": { "get": { "operationId": "campaigns_validate", "summary": "Validate campaign", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "valid": { "type": "boolean", "const": true }, "format": { "type": "string", "const": "flat-video-v1" }, "personalization": { "type": "boolean", "const": false }, "generation_available": { "type": "boolean" }, "workspace_status": { "type": "string", "enum": [ "pending", "dispatching", "ready", "recovery_required" ] } }, "required": [ "id", "valid", "format", "personalization", "generation_available", "workspace_status" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation.", "tags": [ "Campaigns" ], "x-seo": { "title": "Validate campaign — Shuffll Engage API", "description": "Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version." } } }, "/v1/campaigns/{id}/recipients": { "post": { "operationId": "recipients_upsert", "summary": "Add or update recipients", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "recipients:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "items": { "description": "Each record: required external_id (1–200 characters, no surrounding whitespace); optional nullable name, first_name, last_name (up to 200 characters), phone (E.164). Unknown fields reject that item. No personalization or delivery fields.", "minItems": 1, "maxItems": 100, "type": "array", "items": {} } }, "required": [ "items" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.", "tags": [ "Recipients" ], "x-seo": { "title": "Add or update recipients — Shuffll Engage API", "description": "Manage Engage campaign recipient records. Adding names or contact details does not generate, personalize, or send videos." } }, "get": { "operationId": "recipients_list", "summary": "List recipients", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "recipients:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "external_id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locked": { "type": "boolean" }, "created_at": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "campaign_id", "external_id", "name", "first_name", "last_name", "phone", "locked", "created_at", "revision" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "lockedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "data", "nextCursor", "total", "lockedTotal", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.", "tags": [ "Recipients" ], "x-seo": { "title": "List recipients — Shuffll Engage API", "description": "Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending." } } }, "/v1/campaigns/{id}/recipients/{recipient_id}": { "delete": { "operationId": "recipients_delete", "summary": "Delete recipient", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "recipients:write", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "recipient_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.", "tags": [ "Recipients" ], "x-seo": { "title": "Delete recipient — Shuffll Engage API", "description": "Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending." } }, "get": { "operationId": "recipients_get", "summary": "Get recipient", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "recipients:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "recipient_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "external_id": { "type": "string" }, "name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "first_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "phone": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "locked": { "type": "boolean" }, "created_at": { "type": "string" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "campaign_id", "external_id", "name", "first_name", "last_name", "phone", "locked", "created_at", "revision" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata.", "tags": [ "Recipients" ], "x-seo": { "title": "Get recipient — Shuffll Engage API", "description": "Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending." } } }, "/v1/campaigns/{id}/generate": { "post": { "operationId": "campaigns_generate", "summary": "Generate videos", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "campaigns:generate", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "campaign_write", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "recipient_ids": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } }, "required": [ "recipient_ids" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Render fixed video for 1–100 explicitly selected recipients from the immutable campaign revision. Names are contact metadata, not personalization. Durable idempotency; poll jobs and results. Does not send messages.", "tags": [ "Generation" ], "x-seo": { "title": "Generate videos — Shuffll Engage API", "description": "Render fixed clips with the legacy flat-video-v1 Engage campaign operation. Recipient fields do not personalize the video." } } }, "/v1/campaigns/{id}/results": { "get": { "operationId": "campaign_results_list", "summary": "List results", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "results:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "recipient_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "generation_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "recovery_required", "succeeded", "failed" ] }, "video_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "thumbnails": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "timestamp_seconds": { "type": "number", "minimum": 0 }, "width": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "height": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "url", "timestamp_seconds", "width", "height" ], "additionalProperties": false } }, "duration_seconds": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "enum": [ "render_failed", "source_unavailable", "authority_revoked" ] }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "campaign_id", "recipient_id", "generation_id", "revision", "state", "video_url", "thumbnails", "duration_seconds", "error", "created_at" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "data", "nextCursor", "total" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read recipient render attempts, including failures and pending recovery. Media URLs are returned only to authorized readers.", "tags": [ "Results" ], "x-seo": { "title": "List results — Shuffll Engage API", "description": "Shuffll Engage: Read recipient render attempts, including failures and pending recovery." } } }, "/v1/campaigns/{id}/results/{result_id}": { "get": { "operationId": "campaign_results_get", "summary": "Get result", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "results:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "result_id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "recipient_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "generation_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "recovery_required", "succeeded", "failed" ] }, "video_url": { "anyOf": [ { "type": "string", "format": "uri" }, { "type": "null" } ] }, "thumbnails": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "timestamp_seconds": { "type": "number", "minimum": 0 }, "width": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "height": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "url", "timestamp_seconds", "width", "height" ], "additionalProperties": false } }, "duration_seconds": { "anyOf": [ { "type": "number", "exclusiveMinimum": 0 }, { "type": "null" } ] }, "error": { "anyOf": [ { "type": "string", "enum": [ "render_failed", "source_unavailable", "authority_revoked" ] }, { "type": "null" } ] }, "created_at": { "type": "string" } }, "required": [ "id", "campaign_id", "recipient_id", "generation_id", "revision", "state", "video_url", "thumbnails", "duration_seconds", "error", "created_at" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read one exact recipient render attempt and its playable MP4 and timed thumbnails.", "tags": [ "Results" ], "x-seo": { "title": "Get result — Shuffll Engage API", "description": "Shuffll Engage: Read one exact recipient render attempt and its playable MP4 and timed thumbnails." } } }, "/v1/campaigns/{id}/analytics": { "get": { "operationId": "campaign_analytics_get", "summary": "Get analytics", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "analytics:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "campaign_id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "recipients": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "attempts": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "queued": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "running": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "recovery_required": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "succeeded": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "failed": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "campaign_id", "recipients", "attempts", "queued", "running", "recovery_required", "succeeded", "failed" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Campaign-scoped counts of render attempts and recipients. Fixed-video generation does not deliver messages; no engagement or delivery event is inferred from an export.", "tags": [ "Results" ], "x-seo": { "title": "Get analytics — Shuffll Engage API", "description": "Shuffll Engage: Campaign-scoped counts of render attempts and recipients." } } }, "/v1/capabilities": { "get": { "operationId": "capabilities_get", "summary": "Get capabilities", "security": [ { "bearerAuth": [] } ], "x-engage-scope": null, "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "metaOrganizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "operations": { "type": "array", "items": { "type": "string" } }, "transitions": { "type": "array", "items": { "not": {} } }, "apiEnabled": { "type": "boolean" }, "uploads": { "type": "object", "properties": { "media_types": { "type": "array", "items": { "type": "string" } }, "max_bytes": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "finalize_within_seconds": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "upload_capability_validity_seconds": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "media_types", "max_bytes", "finalize_within_seconds", "upload_capability_validity_seconds" ], "additionalProperties": false } }, "required": [ "level", "metaOrganizationId", "organizationId", "scopes", "operations", "transitions", "apiEnabled", "uploads" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Current safe operations and effective entitlements.", "tags": [ "Capabilities" ], "x-seo": { "title": "Get capabilities — Shuffll Engage API", "description": "Shuffll Engage: Current safe operations and effective entitlements." } } }, "/v1/keys": { "get": { "operationId": "keys_list", "summary": "List keys", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "keys:manage", "x-engage-hierarchy": "current", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "default": 50, "type": "integer", "minimum": 1, "maximum": 100 } }, { "name": "cursor", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "level", "in": "query", "required": false, "schema": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] } }, { "name": "metaOrganizationId", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "nextCursor": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, "required": [ "data", "nextCursor" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "List managed credential metadata; verified humans may select an exact managed target.", "tags": [ "API keys" ], "x-seo": { "title": "List keys — Shuffll Engage API", "description": "Shuffll Engage: List managed credential metadata; verified humans may select an exact managed target." } }, "post": { "operationId": "keys_issue", "summary": "Issue key", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "keys:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": true }, "x-engage-side-effects": "credential_issue", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "metaOrganizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "scopes": { "minItems": 1, "maxItems": 100, "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "lifetimeSeconds": { "type": "integer", "minimum": 1, "maximum": 7776000 }, "delegationAllowed": { "default": false, "type": "boolean" } }, "required": [ "level", "metaOrganizationId", "organizationId", "name", "scopes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Issue a scoped credential. MCP returns an authenticated human claim link; REST returns its secret once.", "tags": [ "API keys" ], "x-seo": { "title": "Issue key — Shuffll Engage API", "description": "Shuffll Engage: Issue a scoped credential." } } }, "/v1/keys/{id}": { "get": { "operationId": "keys_get", "summary": "Get key", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "keys:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read managed credential metadata and its current revision.", "tags": [ "API keys" ], "x-seo": { "title": "Get key — Shuffll Engage API", "description": "Shuffll Engage: Read managed credential metadata and its current revision." } }, "delete": { "operationId": "keys_revoke", "summary": "Revoke key", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "keys:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "credential_revoke", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Revoke a credential and its delegated lineage.", "tags": [ "API keys" ], "x-seo": { "title": "Revoke key — Shuffll Engage API", "description": "Shuffll Engage: Revoke a credential and its delegated lineage." } } }, "/v1/keys/{id}/rotate": { "post": { "operationId": "keys_rotate", "summary": "Rotate key", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "keys:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": true }, "x-engage-side-effects": "credential_rotate", "x-engage-idempotency": true, "x-engage-revision": true, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." }, { "name": "If-Match", "in": "header", "required": true, "schema": { "type": "string" }, "description": "Opaque revision from ETag or a job result." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "overlapSeconds": { "default": 0, "type": "integer", "minimum": 0, "maximum": 86400 }, "lifetimeSeconds": { "type": "integer", "minimum": 1, "maximum": 7776000 } }, "required": [], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Rotate a credential with bounded overlap. MCP returns an authenticated human claim link; REST returns its secret once.", "tags": [ "API keys" ], "x-seo": { "title": "Rotate key — Shuffll Engage API", "description": "Shuffll Engage: Rotate a credential with bounded overlap." } } }, "/v1/control/access": { "put": { "operationId": "api_access_set", "summary": "Set access policy", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "api-access:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": true, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "access_policy", "x-engage-idempotency": true, "x-engage-revision": false, "parameters": [ { "name": "Idempotency-Key", "in": "header", "required": true, "schema": { "type": "string", "minLength": 1, "maxLength": 200 }, "description": "Reuse for an uncertain retry of the same intent." } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "metaOrganizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "enabled": { "type": "boolean" }, "scopes": { "maxItems": 100, "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "delegationAllowed": { "default": false, "type": "boolean" }, "selfService": { "default": false, "type": "boolean" }, "readPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "mutationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "generationPerMinute": { "type": "integer", "minimum": 1, "maximum": 100000 }, "activeGenerations": { "type": "integer", "minimum": 1, "maximum": 10000 } }, "required": [ "level", "metaOrganizationId", "organizationId", "enabled", "scopes" ], "additionalProperties": false } } } }, "responses": { "200": { "description": "Terminal operation job.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "202": { "description": "Nonterminal operation job; poll Location after Retry-After seconds.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Location": { "required": true, "description": "Absolute URL of the operation job, from the trusted server origin.", "schema": { "type": "string", "format": "uri" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } }, "ETag": { "description": "Quoted opaque revision when the resource or job result has one.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "job": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false }, "secretAvailable": { "default": false, "type": "boolean" }, "secret": { "type": "string" }, "key": { "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "meta_organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organization_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "name": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "environment": { "type": "string", "const": "dev" }, "display_prefix": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "issuer_key_id": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "delegation_allowed": { "type": "boolean" }, "created_at": { "type": "string" }, "expires_at": { "type": "string" }, "revoked_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_used_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "required": [ "id", "level", "meta_organization_id", "organization_id", "name", "scopes", "environment", "display_prefix", "created_by", "issuer_key_id", "delegation_allowed", "created_at", "expires_at", "revoked_at", "last_used_at" ], "additionalProperties": false } }, "required": [ "job", "secretAvailable" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Human control-plane policy management, including initial activation.", "tags": [ "Access policies" ], "x-seo": { "title": "Set access policy — Shuffll Engage API", "description": "Shuffll Engage: Human control-plane policy management, including initial activation." } }, "get": { "operationId": "api_access_get", "summary": "Get access policy", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "api-access:manage", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": true, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "level", "in": "query", "required": true, "schema": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] } }, { "name": "metaOrganizationId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } }, { "name": "organizationId", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "level": { "type": "string", "enum": [ "platform", "meta_org", "organization" ] }, "metaOrganizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "organizationId": { "anyOf": [ { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, { "type": "null" } ] }, "exists": { "type": "boolean" }, "enabled": { "type": "boolean" }, "targetActive": { "type": "boolean" }, "ancestorsEnabled": { "type": "boolean" }, "scopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "ceilingScopes": { "type": "array", "items": { "type": "string", "enum": [ "meta-organizations:provision", "meta-organizations:read", "meta-organizations:write", "api-access:manage", "organizations:read", "organizations:write", "brands:read", "brands:write", "members:read", "members:write", "assets:read", "assets:write", "templates:read", "templates:write", "templates:use_shared", "templates:generate", "templates:publish", "campaigns:read", "campaigns:write", "campaigns:generate", "campaigns:send", "recipients:read", "recipients:write", "results:read", "analytics:read", "jobs:read", "jobs:write", "webhooks:read", "webhooks:write", "keys:manage", "connections:read", "connections:manage", "connections:sync", "products:read", "products:write" ] } }, "delegationAllowed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "selfService": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "readPerMinute": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "mutationPerMinute": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "generationPerMinute": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] }, "activeGenerations": { "anyOf": [ { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, { "type": "null" } ] } }, "required": [ "level", "metaOrganizationId", "organizationId", "exists", "enabled", "targetActive", "ancestorsEnabled", "scopes", "ceilingScopes", "delegationAllowed", "selfService", "readPerMinute", "mutationPerMinute", "generationPerMinute", "activeGenerations" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read the stored access policy and safe ancestor ceiling for authorized human administrators.", "tags": [ "Access policies" ], "x-seo": { "title": "Get access policy — Shuffll Engage API", "description": "Shuffll Engage: Read the stored access policy and safe ancestor ceiling for authorized human administrators." } } }, "/v1/jobs/{id}": { "get": { "operationId": "jobs_get", "summary": "Get job", "security": [ { "bearerAuth": [] } ], "x-engage-scope": "jobs:read", "x-engage-hierarchy": "verified_target", "x-engage-availability": { "platformOnly": false, "partnerOnly": false, "humanOnly": false, "mcpKeyClaimRequired": false }, "x-engage-side-effects": "none", "x-engage-idempotency": false, "x-engage-revision": false, "parameters": [ { "name": "id", "in": "path", "required": true, "schema": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } } ], "responses": { "200": { "description": "Current resource or page.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "$schema": "http://json-schema.org/draft-07/schema#", "type": "object", "properties": { "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "command": { "type": "string" }, "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "state": { "type": "string", "enum": [ "queued", "running", "waiting_for_approval", "succeeded", "partially_failed", "failed", "cancelling", "cancelled", "recovery_required" ] }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "result": { "anyOf": [ { "type": "object", "properties": { "resourceId": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "revision": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "insertedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "updatedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "deletedTotal": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "index": { "type": "integer", "minimum": 0, "maximum": 99 }, "id": { "type": "string", "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" }, "status": { "type": "string", "enum": [ "inserted", "updated", "unchanged", "deleted", "invalid_request", "duplicate_external_id", "recipient_locked", "resource_not_found" ] } }, "required": [ "index", "status" ], "additionalProperties": false } }, "succeeded": { "type": "number" }, "failed": { "type": "number" }, "secretAvailable": { "type": "boolean", "const": false } }, "additionalProperties": false }, { "type": "null" } ] }, "pollAfterSeconds": { "type": "number" } }, "required": [ "id", "command", "resourceId", "state", "createdAt", "updatedAt", "result", "pollAfterSeconds" ], "additionalProperties": false } } } }, "401": { "description": "Missing or invalid Bearer authentication.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "WWW-Authenticate": { "required": true, "schema": { "type": "string", "enum": [ "Bearer" ] } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "405": { "description": "Method not allowed for this path.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Allow": { "required": true, "description": "Comma-separated methods allowed for this path.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "429": { "description": "Rate limited; wait before retrying.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } }, "Retry-After": { "required": true, "description": "Seconds to wait before polling or retrying.", "schema": { "type": "integer", "minimum": 0 } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } }, "default": { "description": "Error. The JSON body contains error.code and error.requestId.", "headers": { "X-Request-Id": { "required": true, "description": "Identifier for tracing this response.", "schema": { "type": "string", "format": "uuid" } } }, "content": { "application/json": { "schema": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "requestId" ], "properties": { "code": { "type": "string", "enum": [ "activation_prerequisites_missing", "asset_storage_unavailable", "batch_limit_exceeded", "catalog_unavailable", "idempotency_conflict", "insufficient_scope", "invalid_asset", "invalid_request", "method_not_allowed", "not_found", "operation_conflict", "operation_failed", "origin_forbidden", "payload_too_large", "precondition_failed", "precondition_required", "rate_limited", "render_source_unavailable", "tenant_disabled", "transaction_retry_required", "unauthorized", "unsupported_media_type", "upload_expired", "upload_incomplete", "upload_revoked" ] }, "requestId": { "type": "string" } } } } } } } } }, "description": "Read an initiated operation after checking its underlying workflow authority.", "tags": [ "Jobs" ], "x-seo": { "title": "Get job — Shuffll Engage API", "description": "Shuffll Engage: Read an initiated operation after checking its underlying workflow authority." } } } }, "tags": [ { "name": "Partners", "description": "Provision partners and manage their account status." }, { "name": "Organizations", "description": "Create and manage child workspaces within your tenant." }, { "name": "Branding", "description": "Read and update workspace branding." }, { "name": "Members", "description": "Manage workspace membership and roles." }, { "name": "Invitations", "description": "Invite accounts and manage pending invitations." }, { "name": "Uploads", "description": "Create, finalize and revoke private image uploads." }, { "name": "Assets", "description": "Browse owned assets and explicitly publish branding images." }, { "name": "Catalogs", "description": "Discover currently configured options available to your tenant." }, { "name": "Templates", "description": "Discover published templates and their immutable versions." }, { "name": "Campaigns", "description": "Create, configure and coordinate campaigns from published template versions. See each operation for rendering format and generation requirements." }, { "name": "Production settings", "description": "Read and update campaign production settings." }, { "name": "Recipients", "description": "Manage campaign recipients without generating or sending videos." }, { "name": "Generation", "description": "Explicitly start video generation for selected recipients." }, { "name": "Results", "description": "Retrieve video results and campaign render analytics." }, { "name": "API keys", "description": "Issue, inspect, rotate and revoke scoped credentials." }, { "name": "Access policies", "description": "Inspect and administer permitted API access." }, { "name": "Capabilities", "description": "Discover the operations available to the current principal." }, { "name": "Jobs", "description": "Inspect asynchronous operation status and results." } ], "x-tagGroups": [ { "name": "Workspace management", "tags": [ "Partners", "Organizations", "Branding", "Members", "Invitations" ] }, { "name": "Content library", "tags": [ "Uploads", "Assets", "Catalogs", "Templates" ] }, { "name": "Video campaigns", "tags": [ "Campaigns", "Production settings", "Recipients", "Generation", "Results" ] }, { "name": "Access and operations", "tags": [ "API keys", "Access policies", "Capabilities", "Jobs" ] } ] }