{ "openapi": "3.0.3", "info": { "title": "Fendsy Developer API", "version": "1.0.0", "description": "Operations callable with a scoped Fendsy server credential." }, "servers": [ { "url": "https://api.fendsy.com", "description": "Production Control Plane API" }, { "url": "http://localhost:3001", "description": "Local development server" } ], "paths": { "/v1/credentials/verify": { "get": { "summary": "Verify a server API key", "responses": { "200": { "description": "The API key is valid. Returns safe metadata without creating an event.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18getResponsedefault39" } } }, "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "private, no-store" }, "API-Version": { "schema": { "type": "string" }, "example": "v1" }, "Authorization": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18getResponsedefault39" } } }, "headers": { "Cache-Control": { "schema": { "type": "string" }, "example": "private, no-store" }, "API-Version": { "schema": { "type": "string" }, "example": "v1" }, "Authorization": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "description": "Validates any supported developer key and returns safe metadata. No event, dispatch or provider message is created. The response is private/no-store. Revoked or expired keys return 401.\n\nRequired scope: any valid server key.", "tags": [ "Authentication" ], "operationId": "getV1CredentialsVerify", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [] } }, "/v1/events": { "post": { "summary": "Ingest a public event", "responses": { "200": { "description": "An identical event was already received for this Event Source and idempotency key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18postResponsedefault41" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "202": { "description": "A new receipt was persisted. Inspect status: quarantined receipts have validationErrors and no queued dispatch.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18postResponsedefault41" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "409": { "$ref": "#/components/responses/Conflict" }, "429": { "description": "Rate limit exceeded. Wait before retrying the identical event body.", "headers": { "Retry-After": { "schema": { "type": "integer", "example": 60 } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18postResponsedefault41" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "eventId": { "type": "string", "minLength": 1, "maxLength": 255 }, "eventName": { "type": "string", "minLength": 1, "maxLength": 200 }, "idempotencyKey": { "type": "string", "minLength": 1, "maxLength": 200 }, "source": { "type": "string", "minLength": 1, "maxLength": 100 }, "schemaKey": { "type": "string", "minLength": 1, "maxLength": 200, "default": "standard.generic" }, "schemaVersion": { "type": "integer", "exclusiveMinimum": true, "minimum": 0, "maximum": 65535, "default": 1 }, "occurredAt": { "type": "string", "format": "date-time" }, "subject": { "type": "object", "additionalProperties": {}, "default": {} }, "consent": { "type": "object", "additionalProperties": {}, "default": {} }, "money": { "type": "object", "properties": { "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "amount": { "type": "string", "pattern": "^-?(0|[1-9]\\d*)(\\.\\d+)?$", "maxLength": 200 }, "precision": { "type": "integer", "minimum": 0, "maximum": 18 }, "minorAmount": { "type": "string", "pattern": "^-?\\d+$", "maxLength": 200 } }, "required": [ "currency", "amount", "precision" ], "additionalProperties": false }, "trace": { "type": "object", "additionalProperties": {}, "default": {} }, "payload": { "type": "object", "additionalProperties": {} } }, "required": [ "eventName", "idempotencyKey", "source", "payload" ], "additionalProperties": false }, "example": { "eventId": "order-123-paid", "eventName": "custom.order_paid", "idempotencyKey": "order-123-paid", "source": "order_server", "schemaKey": "standard.generic", "schemaVersion": 1, "occurredAt": "2026-09-02T05:00:00Z", "payload": { "orderId": "123" }, "money": { "currency": "INR", "amount": "125.00", "precision": 2 } } } } }, "description": "Requires events:write. The credential determines tenant ownership and Event Source; body source is a descriptive label. Reuse the same JSON body and idempotencyKey on retries. New receipts return 202; exact replays return 200; changed content under the same source/key returns 409. A 202 quarantined receipt has validationErrors and no queued dispatch. Analytics/report visibility is asynchronous. Limit: 120 requests per minute per key when the coordination service is available. Retry 429 after Retry-After; never retry a 409 blindly.\n\nRequired scope: events:write.", "tags": [ "Events" ], "operationId": "postV1Events", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "events:write" ] } }, "/v1/sites/{publicId}/identity-tokens": { "post": { "summary": "Create onsite identity token", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group18postResponse20138" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "404": { "$ref": "#/components/responses/NotFound" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "parameters": [ { "name": "publicId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group18postParameters36/properties/publicId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "customerProfileId": { "type": "string", "minLength": 1, "maxLength": 100 } }, "required": [ "customerProfileId" ], "additionalProperties": false } } } }, "description": "Trusted-server operation. Requires identity:write (legacy events:write keys remain supported). Both Site and customerProfileId must belong to the key's organization. Pass the short-lived token to Fendsy.identify; never expose the API key.\n\nRequired scope: identity:write or events:write.", "tags": [ "Sites and identity" ], "operationId": "postV1SitesPublicIdIdentityTokens", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "identity:write" ], "x-required-scope-alternatives": [ [ "identity:write" ], [ "events:write" ] ] } }, "/v1/catalog/items": { "get": { "summary": "List merchant Catalog Items", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Response returned by this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault1" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "sort", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/sort" }, "style": "form", "explode": true }, { "name": "status", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/status" }, "style": "form", "explode": true }, { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/cursor" }, "style": "form", "explode": true }, { "name": "search", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/search" }, "style": "form", "explode": true }, { "name": "kind", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/kind" }, "style": "form", "explode": true }, { "name": "provider", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/provider" }, "style": "form", "explode": true }, { "name": "categoryId", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters0/properties/categoryId" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Cursor-paginated Catalog Items for an organization credential.\n\nRequired scope: catalog:read.", "tags": [ "Catalog" ], "operationId": "getV1CatalogItems", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "catalog:read" ] }, "post": { "summary": "Create merchant Catalog Item", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse2013" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody2" } } } }, "description": "Create a manual Catalog Item with an Idempotency-Key.\n\nRequired scope: catalog:write.", "tags": [ "Catalog" ], "operationId": "postV1CatalogItems", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "catalog:write" ] } }, "/v1/catalog/items/{itemId}": { "get": { "summary": "Get merchant Catalog Item", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Response returned by this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault5" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "itemId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters4/properties/itemId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read an Item and its active Variants.\n\nRequired scope: catalog:read.", "tags": [ "Catalog" ], "operationId": "getV1CatalogItemsItemId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "catalog:read" ] } }, "/v1/orders": { "get": { "summary": "List merchant orders", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Response returned by this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault9" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters8/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters8/properties/cursor" }, "style": "form", "explode": true }, { "name": "customerProfileId", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters8/properties/customerProfileId" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded page of merchant-confirmed orders.\n\nRequired scope: orders:read.", "tags": [ "Orders" ], "operationId": "getV1Orders", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "orders:read" ] }, "post": { "summary": "Confirm merchant order", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from 200 | 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault7" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody6" } } } }, "description": "Submit a signed, retry-safe confirmed order with immutable item and money snapshots.\n\nRequired scope: orders:write.", "tags": [ "Orders" ], "operationId": "postV1Orders", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "orders:write" ] } }, "/v1/orders/{orderId}": { "get": { "summary": "Get merchant order", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Response returned by this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault11" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters10/properties/orderId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read the confirmed order and its immutable item and shipping snapshots.\n\nRequired scope: orders:read.", "tags": [ "Orders" ], "operationId": "getV1OrdersOrderId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "orders:read" ] } }, "/v1/orders/{orderId}/milestones": { "post": { "summary": "Record order milestone", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Response returned by this operation.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault14" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "orderId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters12/properties/orderId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody13" } } } }, "description": "Record payment, fulfillment, delivery, cancellation or refund evidence.\n\nRequired scope: orders:write.", "tags": [ "Orders" ], "operationId": "postV1OrdersOrderIdMilestones", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "orders:write" ] } }, "/v1/audience/profiles": { "get": { "summary": "List Customer Profiles", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault16" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters15/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters15/properties/cursor" }, "style": "form", "explode": true }, { "name": "search", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters15/properties/search" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded organization-wide page without private identity evidence.\n\nRequired scope: audience:read.", "tags": [ "Customer Profiles" ], "operationId": "getV1AudienceProfiles", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "post": { "summary": "Create or resolve Customer Profile", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault18" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody17" } } } }, "description": "Use a contact identity and Idempotency-Key; this does not grant marketing consent.\n\nRequired scope: audience:write.", "tags": [ "Customer Profiles" ], "operationId": "postV1AudienceProfiles", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/profiles/{profileId}": { "get": { "summary": "Get Customer Profile", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault20" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters19/properties/profileId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read allowlisted profile fields.\n\nRequired scope: audience:read.", "tags": [ "Customer Profiles" ], "operationId": "getV1AudienceProfilesProfileId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "patch": { "summary": "Update Customer Profile", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchResponsedefault23" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19patchParameters21/properties/profileId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchBody22" } } } }, "description": "Update allowlisted identity fields without changing consent.\n\nRequired scope: audience:write.", "tags": [ "Customer Profiles" ], "operationId": "patchV1AudienceProfilesProfileId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists": { "get": { "summary": "List static Lists", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault25" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters24/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters24/properties/cursor" }, "style": "form", "explode": true }, { "name": "includeArchived", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters24/properties/includeArchived" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded page of static Audience Lists.\n\nRequired scope: audience:read.", "tags": [ "Lists" ], "operationId": "getV1AudienceLists", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "post": { "summary": "Create static List", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault27" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody26" } } } }, "description": "Create an explicit static List with an Idempotency-Key.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "postV1AudienceLists", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists/{listId}": { "get": { "summary": "Get static List", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault29" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters28/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read List lifecycle and member count.\n\nRequired scope: audience:read.", "tags": [ "Lists" ], "operationId": "getV1AudienceListsListId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "patch": { "summary": "Update static List", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchResponsedefault32" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19patchParameters30/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchBody31" } } } }, "description": "Update List name or description without changing members.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "patchV1AudienceListsListId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists/{listId}/archive": { "post": { "summary": "Archive static List", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault34" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters33/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Archive a List and preserve its provenance for restore.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "postV1AudienceListsListIdArchive", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists/{listId}/restore": { "post": { "summary": "Restore static List", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault36" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters35/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Restore an archived List with credential audit.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "postV1AudienceListsListIdRestore", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists/{listId}/members": { "get": { "summary": "List List members", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault39" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters37/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters37/properties/cursor" }, "style": "form", "explode": true }, { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters38/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded member pages with original join provenance.\n\nRequired scope: audience:read.", "tags": [ "Lists" ], "operationId": "getV1AudienceListsListIdMembers", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "post": { "summary": "Add List member", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault42" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters40/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody41" } } } }, "description": "Add an existing Profile without changing marketing consent or its original join source.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "postV1AudienceListsListIdMembers", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/lists/{listId}/members/{profileId}": { "delete": { "summary": "Remove List member", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19deleteResponsedefault44" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "profileId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19deleteParameters43/properties/profileId" } }, { "name": "listId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19deleteParameters43/properties/listId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Remove a Profile from a static List with lifecycle evidence.\n\nRequired scope: audience:write.", "tags": [ "Lists" ], "operationId": "deleteV1AudienceListsListIdMembersProfileId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/segments": { "get": { "summary": "List Segments", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault46" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters45/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters45/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded Segment Definition and lifecycle pages.\n\nRequired scope: audience:read.", "tags": [ "Segments" ], "operationId": "getV1AudienceSegments", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "post": { "summary": "Create Segment draft", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault48" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody47" } } } }, "description": "Create a version 1 draft with an Idempotency-Key.\n\nRequired scope: audience:write.", "tags": [ "Segments" ], "operationId": "postV1AudienceSegments", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/segments/catalog": { "get": { "summary": "Get condition catalog", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault49" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "description": "Read the authorized condition catalog and source health.\n\nRequired scope: audience:read.", "tags": [ "Segments" ], "operationId": "getV1AudienceSegmentsCatalog", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] } }, "/v1/audience/segments/{segmentId}": { "get": { "summary": "Get Segment", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault51" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "segmentId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters50/properties/segmentId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a Segment Definition and its revision state.\n\nRequired scope: audience:read.", "tags": [ "Segments" ], "operationId": "getV1AudienceSegmentsSegmentId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:read" ] }, "patch": { "summary": "Update Segment draft", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchResponsedefault54" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "segmentId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19patchParameters52/properties/segmentId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19patchBody53" } } } }, "description": "Update a draft with its expected version.\n\nRequired scope: audience:write.", "tags": [ "Segments" ], "operationId": "patchV1AudienceSegmentsSegmentId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/audience/segments/{segmentId}/activate": { "post": { "summary": "Activate Segment draft", "responses": { "202": { "description": "Status 202", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20257" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "parameters": [ { "name": "segmentId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters55/properties/segmentId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody56" } } } }, "description": "Publish the exact draft revision and queue evaluation; accepted is not ready membership.\n\nRequired scope: audience:write.", "tags": [ "Segments" ], "operationId": "postV1AudienceSegmentsSegmentIdActivate", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "audience:write" ] } }, "/v1/analytics/event-definitions": { "get": { "summary": "List Event Definitions", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault59" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters58/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters58/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded definitions and governance state.\n\nRequired scope: analytics:read.", "tags": [ "Analytics" ], "operationId": "getV1AnalyticsEventDefinitions", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "analytics:read" ] } }, "/v1/analytics/receipts/{receiptId}": { "get": { "summary": "Get event receipt", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault61" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "receiptId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters60/properties/receiptId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read accepted and downstream processing status without raw event payload.\n\nRequired scope: analytics:read.", "tags": [ "Analytics" ], "operationId": "getV1AnalyticsReceiptsReceiptId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "analytics:read" ] } }, "/v1/analytics/reports": { "get": { "summary": "List reports", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault63" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters62/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters62/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded approved report definitions.\n\nRequired scope: analytics:read.", "tags": [ "Analytics" ], "operationId": "getV1AnalyticsReports", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "analytics:read" ] } }, "/v1/analytics/dashboards": { "get": { "summary": "List dashboards", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault65" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters64/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters64/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded saved Dashboard card summaries.\n\nRequired scope: analytics:read.", "tags": [ "Analytics" ], "operationId": "getV1AnalyticsDashboards", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "analytics:read" ] } }, "/v1/analytics/dashboards/{dashboardId}/cards/{cardId}/query": { "get": { "summary": "Query saved Dashboard card", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault68" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "from", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters66/properties/from" } }, { "name": "to", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters66/properties/to" } }, { "name": "reportingTimezone", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters66/properties/reportingTimezone" } }, { "name": "dashboardId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters67/properties/dashboardId" } }, { "name": "cardId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters67/properties/cardId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded 31-day aggregate from a permitted saved card.\n\nRequired scope: analytics:read.", "tags": [ "Analytics" ], "operationId": "getV1AnalyticsDashboardsDashboardIdCardsCardIdQuery", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "analytics:read" ] } }, "/v1/customers/{profileId}/orders": { "get": { "summary": "List Customer orders", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault71" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters69/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters69/properties/cursor" }, "style": "form", "explode": true }, { "name": "profileId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters70/properties/profileId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read allowlisted confirmed order history for one Customer Profile.\n\nRequired scope: customer_history:read.", "tags": [ "Customer history" ], "operationId": "getV1CustomersProfileIdOrders", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "customer_history:read" ] } }, "/v1/billing/account": { "get": { "summary": "Read Fendsy account billing", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault72" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "description": "Read Organization plan, usage and invoice summary without payment actions.\n\nRequired scope: account_billing:read.", "tags": [ "Billing" ], "operationId": "getV1BillingAccount", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "account_billing:read" ] } }, "/v1/templates": { "get": { "summary": "List published Templates", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault74" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters73/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters73/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read bounded published Email Template pages.\n\nRequired scope: templates:read.", "tags": [ "Templates" ], "operationId": "getV1Templates", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:read" ] }, "post": { "summary": "Create Template draft", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20176" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody75" } } } }, "description": "Create an organization Email Template draft with an Idempotency-Key; credential is the actor.\n\nRequired scope: templates:write.", "tags": [ "Templates" ], "operationId": "postV1Templates", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:write" ] } }, "/v1/templates/{templateId}/draft": { "get": { "summary": "Read Template draft", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault86" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters85/properties/templateId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read an organization Template draft with templates:write scope.\n\nRequired scope: templates:write.", "tags": [ "Templates" ], "operationId": "getV1TemplatesTemplateIdDraft", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:write" ] }, "put": { "summary": "Replace Template draft", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19putResponsedefault89" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19putParameters87/properties/templateId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19putBody88" } } } }, "description": "Save a validated draft with its expected version.\n\nRequired scope: templates:write.", "tags": [ "Templates" ], "operationId": "putV1TemplatesTemplateIdDraft", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:write" ] } }, "/v1/templates/{templateId}/versions/{version}/edit": { "post": { "summary": "Edit published Template", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20191" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters90/properties/version" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters90/properties/templateId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Create a new editable draft from a published version.\n\nRequired scope: templates:write.", "tags": [ "Templates" ], "operationId": "postV1TemplatesTemplateIdVersionsVersionEdit", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:write" ] } }, "/v1/templates/{templateId}/publish": { "post": { "summary": "Publish Template draft", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20194" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "parameters": [ { "name": "templateId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters92/properties/templateId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody93" } } } }, "description": "Publish the exact draft revision using a separately scoped credential and Idempotency-Key.\n\nRequired scope: templates:publish.", "tags": [ "Templates" ], "operationId": "postV1TemplatesTemplateIdPublish", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:publish" ] } }, "/v1/templates/{templateId}/versions/{version}": { "get": { "summary": "Get published Template version", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault78" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "version", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters77/properties/version" } }, { "name": "templateId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters77/properties/templateId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read one immutable Template version and document.\n\nRequired scope: templates:read.", "tags": [ "Templates" ], "operationId": "getV1TemplatesTemplateIdVersionsVersion", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "templates:read" ] } }, "/v1/campaigns": { "get": { "summary": "List Campaigns", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault96" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters95/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters95/properties/cursor" }, "style": "form", "explode": true }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded Campaign page for the credential organization.\n\nRequired scope: campaigns:read.", "tags": [ "Campaigns" ], "operationId": "getV1Campaigns", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:read" ] }, "post": { "summary": "Create Campaign draft", "responses": { "201": { "description": "Status 201", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20198" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody97" } } } }, "description": "Create a credential-authored Campaign through the workspace domain service.\n\nRequired scope: campaigns:write.", "tags": [ "Campaigns" ], "operationId": "postV1Campaigns", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/v1/campaigns/{campaignId}": { "get": { "summary": "Get Campaign", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault100" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters99/properties/campaignId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read the current Campaign revision and latest run ID.\n\nRequired scope: campaigns:read.", "tags": [ "Campaigns" ], "operationId": "getV1CampaignsCampaignId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/v1/campaigns/{campaignId}/revision": { "put": { "summary": "Replace Campaign draft revision", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19putResponsedefault103" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19putParameters101/properties/campaignId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19putBody102" } } } }, "description": "Save a Campaign draft with an expected version; no send occurs.\n\nRequired scope: campaigns:write.", "tags": [ "Campaigns" ], "operationId": "putV1CampaignsCampaignIdRevision", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/v1/campaigns/{campaignId}/validate": { "post": { "summary": "Validate Campaign", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault106" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters104/properties/campaignId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody105" } } } }, "description": "Pin a ready revision only after audience, sender and content checks pass.\n\nRequired scope: campaigns:write.", "tags": [ "Campaigns" ], "operationId": "postV1CampaignsCampaignIdValidate", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:write" ] } }, "/v1/campaigns/{campaignId}/schedule": { "post": { "summary": "Schedule Campaign", "responses": { "202": { "description": "Status 202", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse202109" } } }, "headers": { "Retry-After": { "schema": { "type": "string" }, "example": "60" }, "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters107/properties/campaignId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody108" } } } }, "description": "Queue a ready Campaign through the same recipient pipeline as the workspace.\n\nRequired scope: campaigns:publish.", "tags": [ "Campaigns" ], "operationId": "postV1CampaignsCampaignIdSchedule", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:publish" ] } }, "/v1/campaigns/{campaignId}/runs": { "get": { "summary": "List Campaign runs", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault114" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "limit", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters112/properties/limit" }, "style": "form", "explode": true }, { "name": "cursor", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Group19getParameters112/properties/cursor" }, "style": "form", "explode": true }, { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters113/properties/campaignId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a bounded page of aggregate Campaign run status.\n\nRequired scope: campaigns:read.", "tags": [ "Campaigns" ], "operationId": "getV1CampaignsCampaignIdRuns", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/v1/campaigns/{campaignId}/runs/{runId}": { "get": { "summary": "Get Campaign run", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault111" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters110/properties/campaignId" } }, { "name": "runId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters110/properties/runId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read aggregate delivery and failure counts for one run.\n\nRequired scope: campaigns:read.", "tags": [ "Campaigns" ], "operationId": "getV1CampaignsCampaignIdRunsRunId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:read" ] } }, "/v1/campaigns/{campaignId}/runs/{runId}/{action}": { "post": { "summary": "Control Campaign run", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault117" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "campaignId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters115/properties/campaignId" } }, { "name": "runId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters115/properties/runId" } }, { "name": "action", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19postParameters115/properties/action" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody116" } } } }, "description": "Pause, resume or cancel one run with an Idempotency-Key.\n\nRequired scope: campaigns:publish.", "tags": [ "Campaigns" ], "operationId": "postV1CampaignsCampaignIdRunsRunIdAction", "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "campaigns:publish" ] } }, "/v1/saas/events": { "post": { "summary": "Report SaaS lifecycle fact", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponsedefault119" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody118" } } } }, "description": "Report a Customer-bound account, trial or plan outcome from a scoped server credential.\n\nRequired scope: saas:write.", "tags": [ "SaaS lifecycle" ], "operationId": "postV1SaasEvents", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "saas:write" ] } }, "/v1/sends/marketing": { "post": { "summary": "Queue one marketing email", "responses": { "202": { "description": "Status 202", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20280" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" }, "example": "60" }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody79" } } } }, "description": "Send one eligible Customer a published Template with an Idempotency-Key; returns a delivery ID.\n\nRequired scope: sends:marketing.", "tags": [ "Sends" ], "operationId": "postV1SendsMarketing", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "sends:marketing" ] } }, "/v1/sends/service": { "post": { "summary": "Queue one order confirmation", "responses": { "202": { "description": "Status 202", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postResponse20282" } } }, "headers": { "Idempotency-Key": { "schema": { "type": "string" } }, "Retry-After": { "schema": { "type": "string" }, "example": "60" }, "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } }, "400": { "$ref": "#/components/responses/BadRequest" }, "500": { "$ref": "#/components/responses/InternalError" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19postBody81" } } } }, "description": "Send one confirmed merchant order with an explicit reason and published service Template. Shopify orders remain on Shopify confirmation by default.\n\nRequired scope: sends:service.", "tags": [ "Sends" ], "operationId": "postV1SendsService", "parameters": [ { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "security": [ { "developerCredential": [] } ], "x-required-scopes": [ "sends:service" ] } }, "/v1/sends/{deliveryId}": { "get": { "summary": "Get send status", "responses": { "400": { "$ref": "#/components/responses/BadRequest" }, "401": { "$ref": "#/components/responses/Unauthorized" }, "403": { "$ref": "#/components/responses/Forbidden" }, "429": { "$ref": "#/components/responses/RateLimited" }, "500": { "$ref": "#/components/responses/InternalError" }, "503": { "$ref": "#/components/responses/ServiceUnavailable" }, "default": { "description": "Generic status from T[\"status\"]", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Group19getResponsedefault84" } } }, "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } } } }, "parameters": [ { "name": "deliveryId", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/Group19getParameters83/properties/deliveryId" } }, { "name": "x-request-id", "in": "header", "required": false, "description": "Optional caller-provided correlation ID. The API generates one when omitted.", "schema": { "type": "string" } } ], "description": "Read a delivery authorized for this credential's send scope.\n\nRequired scope: sends:marketing or sends:service.", "tags": [ "Sends" ], "operationId": "getV1SendsDeliveryId", "security": [ { "developerCredential": [] } ], "x-required-scopes": [], "x-required-scope-alternatives": [ [ "sends:marketing" ], [ "sends:service" ] ] } } }, "components": { "securitySchemes": { "developerCredential": { "type": "http", "scheme": "bearer", "bearerFormat": "Fendsy developer credential", "description": "Scoped fdy_live_* credential passed in the Authorization header." } }, "schemas": { "Group18getResponsedefault39": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "keyPrefix": { "type": "string" }, "scopes": { "type": "array", "items": { "type": "string" } }, "siteId": { "type": "string", "nullable": true }, "expiresAt": { "type": "string", "nullable": true } }, "required": [ "id", "organizationId", "keyPrefix", "scopes", "siteId", "expiresAt" ] }, "ApiError": { "type": "object", "required": [ "error", "code", "status", "requestId", "timestamp", "retryable" ], "properties": { "error": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "integer", "minimum": 400, "maximum": 599 }, "requestId": { "type": "string" }, "timestamp": { "type": "string", "format": "date-time" }, "retryable": { "type": "boolean" }, "nextStep": { "type": "string" }, "nextPath": { "type": "string" }, "details": {} }, "additionalProperties": false }, "Group18postResponsedefault41": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "duplicate": { "type": "boolean" } }, "required": [ "id", "status", "duplicate" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "duplicate": { "type": "boolean" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "path", "message" ] } }, "providerReceiptId": { "type": "string" } }, "required": [ "id", "status", "duplicate", "validationErrors", "providerReceiptId" ] } ] }, "Group18postResponse20138": { "type": "object", "properties": { "token": { "type": "string" }, "expiresInSeconds": { "type": "number" } }, "required": [ "token", "expiresInSeconds" ] }, "Group18postParameters36": { "type": "object", "properties": { "publicId": { "type": "string" } } }, "Group19getResponsedefault1": { "type": "object", "properties": { "items": { "type": "array", "items": {} }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters0": { "type": "object", "properties": { "sort": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "status": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "search": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "kind": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "provider": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "categoryId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponse2013": { "type": "object" }, "Group19postBody2": { "type": "object", "properties": { "title": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "active", "archived" ] }, "kind": { "type": "string", "enum": [ "physical", "digital", "service", "gift_card", "bundle", "unknown" ] }, "metadata": { "type": "object", "additionalProperties": {} }, "externalId": { "type": "string" }, "description": { "type": "string", "nullable": true }, "capabilities": { "type": "object", "additionalProperties": { "type": "boolean" } }, "vendor": { "type": "string", "nullable": true }, "productType": { "type": "string", "nullable": true }, "handle": { "type": "string", "nullable": true }, "url": { "type": "string", "nullable": true }, "imageUrl": { "type": "string", "nullable": true }, "images": { "type": "array", "items": { "type": "string" } }, "tags": {}, "variants": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "priceAmount": { "type": "number" }, "currencyCode": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "active", "archived" ] }, "metadata": {}, "externalId": { "type": "string" }, "sku": { "type": "string", "nullable": true }, "barcode": { "type": "string", "nullable": true }, "selectedOptions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ] } }, "compareAtAmount": { "type": "number", "nullable": true }, "requiresShipping": { "type": "boolean" }, "taxable": { "type": "boolean" }, "weightValue": { "type": "number", "nullable": true }, "weightUnit": { "type": "string", "nullable": true }, "inventoryPolicy": { "type": "string", "enum": [ "deny", "continue" ] }, "fulfillmentService": { "type": "string", "nullable": true } }, "required": [ "title", "priceAmount", "currencyCode" ] } }, "serviceTerms": { "oneOf": [ { "type": "object", "properties": { "billingType": { "type": "string", "enum": [ "one_time" ] }, "durationMinutes": { "type": "number", "nullable": true }, "bookingRequired": { "type": "boolean" } }, "required": [ "billingType" ] }, { "type": "object", "properties": { "billingType": { "type": "string", "enum": [ "recurring" ] }, "interval": { "type": "string", "enum": [ "month", "year" ] }, "durationMinutes": { "type": "number", "nullable": true }, "bookingRequired": { "type": "boolean" }, "intervalCount": { "type": "number" } }, "required": [ "billingType", "interval" ] } ], "nullable": true }, "categoryIds": {} }, "required": [ "title" ] }, "Group19getResponsedefault5": { "type": "object" }, "Group19getParameters4": { "type": "object", "properties": { "itemId": { "type": "string" } } }, "Group19getResponsedefault9": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "variantId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "variantTitle": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "quantity": { "type": "number" }, "unitPrice": { "type": "string" }, "totalAmount": { "type": "string" } }, "required": [ "id", "productId", "variantId", "title", "variantTitle", "sku", "quantity", "unitPrice", "totalAmount" ] } }, "id": { "type": "string" }, "externalOrderId": { "type": "string" }, "customerProfileId": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "confirmedAt": { "type": "string" }, "fulfillmentState": { "type": "string" }, "fulfilledAt": { "type": "string", "nullable": true }, "deliveredAt": { "type": "string", "nullable": true }, "cancelledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true } }, "required": [ "id", "externalOrderId", "customerProfileId", "status", "currency", "totalAmount", "confirmedAt", "fulfillmentState", "fulfilledAt", "deliveredAt", "cancelledAt", "refundedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters8": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "customerProfileId": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponsedefault7": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "variantId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "variantTitle": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "quantity": { "type": "number" }, "unitPrice": { "type": "string" }, "totalAmount": { "type": "string" } }, "required": [ "id", "productId", "variantId", "title", "variantTitle", "sku", "quantity", "unitPrice", "totalAmount" ] } }, "id": { "type": "string" }, "externalOrderId": { "type": "string" }, "customerProfileId": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "confirmedAt": { "type": "string" }, "fulfillmentState": { "type": "string" }, "fulfilledAt": { "type": "string", "nullable": true }, "deliveredAt": { "type": "string", "nullable": true }, "cancelledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true } }, "required": [ "duplicate", "id", "externalOrderId", "customerProfileId", "status", "currency", "totalAmount", "confirmedAt", "fulfillmentState", "fulfilledAt", "deliveredAt", "cancelledAt", "refundedAt" ] }, "Group19postBody6": { "type": "object", "properties": { "externalOrderId": { "type": "string", "minLength": 1, "maxLength": 200 }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody6/properties/externalOrderId" }, "siteId": { "$ref": "#/components/schemas/Group19postBody6/properties/externalOrderId" }, "confirmedAt": { "type": "string", "format": "date-time" }, "currency": { "type": "string", "pattern": "^[A-Z]{3}$" }, "paymentState": { "type": "string", "enum": [ "pending", "paid" ] }, "paymentMethod": { "type": "string", "enum": [ "cash_on_delivery", "card", "bank_transfer", "other" ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "catalogVariantId": { "$ref": "#/components/schemas/Group19postBody6/properties/externalOrderId" }, "quantity": { "type": "integer", "minimum": 1, "maximum": 10000 }, "unitPrice": { "type": "string", "pattern": "^\\d{1,12}(?:\\.\\d{1,4})?$" } }, "required": [ "catalogVariantId", "quantity", "unitPrice" ], "additionalProperties": false }, "minItems": 1, "maxItems": 100 }, "discountAmount": { "$ref": "#/components/schemas/Group19postBody6/properties/items/items/properties/unitPrice", "default": "0" }, "taxAmount": { "$ref": "#/components/schemas/Group19postBody6/properties/items/items/properties/unitPrice", "default": "0" }, "shippingAmount": { "$ref": "#/components/schemas/Group19postBody6/properties/items/items/properties/unitPrice", "default": "0" }, "totalAmount": { "$ref": "#/components/schemas/Group19postBody6/properties/items/items/properties/unitPrice" }, "shippingAddress": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "line1": { "type": "string", "minLength": 1, "maxLength": 300 }, "line2": { "type": "string", "maxLength": 300 }, "city": { "type": "string", "maxLength": 100 }, "region": { "type": "string", "maxLength": 100 }, "postalCode": { "type": "string", "maxLength": 40 }, "countryCode": { "type": "string", "pattern": "^[A-Z]{2}$" } }, "required": [ "line1", "countryCode" ], "additionalProperties": false } }, "required": [ "externalOrderId", "customerProfileId", "confirmedAt", "currency", "paymentState", "paymentMethod", "items", "totalAmount" ], "additionalProperties": false, "x-schema-name": "externalOrderBody" }, "Group19getResponsedefault11": { "type": "object", "properties": { "shippingAddress": {}, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "variantId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "variantTitle": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "quantity": { "type": "number" }, "unitPrice": { "type": "string" }, "totalAmount": { "type": "string" } }, "required": [ "id", "productId", "variantId", "title", "variantTitle", "sku", "quantity", "unitPrice", "totalAmount" ] } }, "id": { "type": "string" }, "externalOrderId": { "type": "string" }, "customerProfileId": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "confirmedAt": { "type": "string" }, "fulfillmentState": { "type": "string" }, "fulfilledAt": { "type": "string", "nullable": true }, "deliveredAt": { "type": "string", "nullable": true }, "cancelledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true } }, "required": [ "shippingAddress", "id", "externalOrderId", "customerProfileId", "status", "currency", "totalAmount", "confirmedAt", "fulfillmentState", "fulfilledAt", "deliveredAt", "cancelledAt", "refundedAt" ] }, "Group19getParameters10": { "type": "object", "properties": { "orderId": { "type": "string" } } }, "Group19postResponsedefault14": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "productId": { "type": "string", "nullable": true }, "variantId": { "type": "string", "nullable": true }, "title": { "type": "string" }, "variantTitle": { "type": "string", "nullable": true }, "sku": { "type": "string", "nullable": true }, "quantity": { "type": "number" }, "unitPrice": { "type": "string" }, "totalAmount": { "type": "string" } }, "required": [ "id", "productId", "variantId", "title", "variantTitle", "sku", "quantity", "unitPrice", "totalAmount" ] } }, "id": { "type": "string" }, "externalOrderId": { "type": "string" }, "customerProfileId": { "type": "string" }, "status": { "type": "string" }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "confirmedAt": { "type": "string" }, "fulfillmentState": { "type": "string" }, "fulfilledAt": { "type": "string", "nullable": true }, "deliveredAt": { "type": "string", "nullable": true }, "cancelledAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true } }, "required": [ "duplicate", "id", "externalOrderId", "customerProfileId", "status", "currency", "totalAmount", "confirmedAt", "fulfillmentState", "fulfilledAt", "deliveredAt", "cancelledAt", "refundedAt" ] }, "Group19postParameters12": { "type": "object", "properties": { "orderId": { "type": "string" } } }, "Group19postBody13": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "paid", "fulfilled", "delivered", "cancelled", "refunded" ] }, "occurredAt": { "type": "string", "format": "date-time" }, "reference": { "type": "string", "minLength": 1, "maxLength": 200 } }, "required": [ "state", "occurredAt", "reference" ], "additionalProperties": false, "x-schema-name": "externalOrderMilestoneBody" }, "Group19getResponsedefault16": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "displayName", "email", "phone", "createdAt", "updatedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters15": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "search": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponsedefault18": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "profile": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "displayName", "email", "phone", "createdAt", "updatedAt" ] }, "created": { "type": "boolean" } }, "required": [ "duplicate", "profile", "created" ] }, "Group19postBody17": { "type": "object", "properties": { "displayName": { "type": "string" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" } } }, "Group19getResponsedefault20": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "displayName", "email", "phone", "createdAt", "updatedAt" ] }, "Group19getParameters19": { "type": "object", "properties": { "profileId": { "type": "string" } } }, "Group19patchResponsedefault23": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "displayName", "email", "phone", "createdAt", "updatedAt" ] }, "Group19patchParameters21": { "type": "object", "properties": { "profileId": { "type": "string" } } }, "Group19patchBody22": { "type": "object", "properties": { "displayName": { "type": "string", "nullable": true }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true } } }, "Group19getResponsedefault25": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters24": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "includeArchived": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponsedefault27": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "duplicate", "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] }, "Group19postBody26": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "name" ] }, "Group19getResponsedefault29": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] }, "Group19getParameters28": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19patchResponsedefault32": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] }, "Group19patchParameters30": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19patchBody31": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string", "nullable": true } } }, "Group19postResponsedefault34": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] }, "Group19postParameters33": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19postResponsedefault36": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "source": { "type": "string" }, "memberCount": { "type": "number" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "source", "memberCount", "createdAt", "updatedAt" ] }, "Group19postParameters35": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19getResponsedefault39": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "profile": { "type": "object", "properties": { "id": { "type": "string" }, "firstName": { "type": "string", "nullable": true }, "lastName": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "email": { "type": "string", "nullable": true }, "phone": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "firstName", "lastName", "displayName", "email", "phone", "createdAt", "updatedAt" ] }, "source": { "type": "string" }, "addedAt": { "type": "string" } }, "required": [ "id", "profile", "source", "addedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters37": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getParameters38": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19postResponsedefault42": { "type": "object", "properties": { "id": { "type": "string" }, "profileId": { "type": "string" }, "source": { "type": "string" }, "created": { "type": "boolean" } }, "required": [ "id", "profileId", "source", "created" ] }, "Group19postParameters40": { "type": "object", "properties": { "listId": { "type": "string" } } }, "Group19postBody41": { "type": "object", "properties": { "profileId": { "type": "string" } }, "required": [ "profileId" ] }, "Group19deleteResponsedefault44": { "type": "object", "properties": { "profileId": { "type": "string" }, "deleted": { "type": "boolean" } }, "required": [ "profileId", "deleted" ] }, "Group19deleteParameters43": { "type": "object", "properties": { "profileId": { "type": "string" }, "listId": { "type": "string" } } }, "Group19getResponsedefault46": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "evaluationStatus": { "type": "string" }, "memberCount": { "type": "number" }, "activeRevisionId": { "type": "string", "nullable": true }, "draftRevisionId": { "type": "string", "nullable": true }, "definition": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "evaluationStatus", "memberCount", "activeRevisionId", "draftRevisionId", "definition", "createdAt", "updatedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters45": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponsedefault48": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "evaluationStatus": { "type": "string" }, "memberCount": { "type": "number" }, "activeRevisionId": { "type": "string", "nullable": true }, "draftRevisionId": { "type": "string", "nullable": true }, "definition": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "duplicate", "id", "name", "description", "status", "evaluationStatus", "memberCount", "activeRevisionId", "draftRevisionId", "definition", "createdAt", "updatedAt" ] }, "Group19postBody47": { "type": "object", "properties": { "name": { "type": "string" }, "definition": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "root": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "group" ] }, "operator": { "type": "string", "enum": [ "and", "or" ] }, "children": { "type": "array", "items": { "oneOf": [ {}, { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "condition" ] }, "source": { "type": "string", "enum": [ "event", "campaign", "site", "profile", "commerce", "segment", "property", "subscription", "consent", "suppression", "preference", "reachability", "list", "commerce_journey", "engagement", "attribution" ] }, "catalogId": { "type": "string" }, "field": { "type": "string" }, "key": { "type": "string" }, "dataType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "propertyType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "channel": { "type": "string", "enum": [ "push", "email", "sms", "whatsapp" ] }, "purpose": { "type": "string" }, "status": { "type": "string" }, "scope": { "type": "string" }, "scopeKey": { "type": "string" }, "listId": { "type": "string" }, "segmentId": { "type": "string" }, "siteId": { "type": "string" }, "campaignId": { "type": "string" }, "metricId": { "type": "string" }, "metricVersionId": { "type": "string" }, "metricKey": { "type": "string" }, "eventName": { "type": "string" }, "eventFamily": { "type": "string" }, "eventPropertyFilters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "dataType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "operator": { "type": "string", "enum": [ "contains", "in", "lt", "lte", "gt", "gte", "eq", "neq", "not_contains", "starts_with", "ends_with", "not_in", "between", "before", "after", "exists", "not_exists", "missing", "is_empty", "is_not_empty" ] }, "value": {} }, "required": [ "key", "dataType", "operator" ], "x-schema-name": "SegmentPropertyFilter" } }, "occurrence": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "at_least", "at_most", "exactly", "zero" ] }, "count": { "type": "number" } }, "required": [ "mode", "count" ] }, "aggregate": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "count", "sum", "min", "max", "average" ] }, "property": { "type": "string" } }, "required": [ "operation" ] }, "timeframe": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all_time" ] } }, "required": [ "mode" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "relative" ] }, "amount": { "type": "number" }, "unit": { "type": "string", "enum": [ "minutes", "hours", "days", "weeks", "months" ] } }, "required": [ "mode", "amount", "unit" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "absolute" ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "mode", "from", "to" ] } ] }, "timeframeDays": { "type": "number" }, "journey": { "type": "string", "enum": [ "checkout_abandoned", "browse_abandoned", "did_without" ] }, "delayMinutes": { "type": "number" }, "funnel": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "metricId": { "type": "string" }, "metricVersionId": { "type": "string" }, "eventFamily": { "type": "string" } }, "required": [ "metricId", "metricVersionId", "eventFamily" ] } }, "maxDelayMinutes": { "type": "number" } }, "required": [ "steps", "maxDelayMinutes" ] }, "operator": { "type": "string", "enum": [ "contains", "in", "lt", "lte", "gt", "gte", "eq", "neq", "not_contains", "starts_with", "ends_with", "not_in", "between", "before", "after", "exists", "not_exists", "missing", "is_empty", "is_not_empty" ] }, "value": {} }, "required": [ "id", "kind", "source", "operator" ], "x-schema-name": "SegmentCondition" } ] } } }, "required": [ "id", "kind", "operator", "children" ], "x-schema-name": "SegmentGroup" } }, "required": [ "version", "root" ], "x-schema-name": "SegmentDefinition" }, "description": { "type": "string" } }, "required": [ "name", "definition" ] }, "Group19getResponsedefault49": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "categories": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "customer_activity" ] }, { "type": "string", "enum": [ "commerce" ] }, { "type": "string", "enum": [ "customer_details" ] }, { "type": "string", "enum": [ "consent_reachability" ] }, { "type": "string", "enum": [ "lists_segments" ] }, { "type": "string", "enum": [ "website_storefront" ] }, { "type": "string", "enum": [ "campaign_engagement" ] }, { "type": "string", "enum": [ "attribution_acquisition" ] } ] }, "minItems": 8, "maxItems": 8 }, "entries": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string", "enum": [ "customer_activity", "commerce", "customer_details", "consent_reachability", "lists_segments", "website_storefront", "campaign_engagement", "attribution_acquisition" ] }, "source": { "type": "string", "enum": [ "event", "campaign", "site", "profile", "commerce", "segment", "property", "subscription", "consent", "suppression", "preference", "reachability", "list", "commerce_journey", "engagement", "attribution" ] }, "field": { "type": "string" }, "key": { "type": "string" }, "dataType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "operators": { "type": "array", "items": { "type": "string", "enum": [ "contains", "in", "lt", "lte", "gt", "gte", "eq", "neq", "not_contains", "starts_with", "ends_with", "not_in", "between", "before", "after", "exists", "not_exists", "missing", "is_empty", "is_not_empty" ] } }, "valueEditor": { "type": "string", "enum": [ "number", "boolean", "text", "date", "event", "money", "enum", "multi_select", "entity", "time_window", "funnel" ] }, "authority": { "type": "string", "enum": [ "postgres", "clickhouse", "composed" ] }, "eventFamily": { "type": "string" }, "metricKey": { "type": "string" }, "sensitivity": { "type": "string", "enum": [ "ordinary", "restricted" ] }, "evidencePolicy": { "type": "string", "enum": [ "summary", "timestamp", "privileged" ] }, "activationReady": { "type": "boolean" }, "metric": { "type": "object", "properties": { "id": { "type": "string" }, "versionId": { "type": "string" }, "version": { "type": "number" }, "key": { "type": "string" }, "eventName": { "type": "string" }, "kind": { "type": "string" } }, "required": [ "id", "versionId", "version", "key", "eventName", "kind" ] }, "property": { "type": "object", "properties": { "descriptorId": { "type": "string" }, "key": { "type": "string" }, "status": { "type": "string" }, "source": { "type": "string" }, "samples": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true }, "lastObservedAt": { "type": "string", "nullable": true } }, "required": [ "descriptorId", "key", "status", "source", "samples", "lastObservedAt" ] } }, "required": [ "id", "label", "description", "category", "source", "dataType", "operators", "valueEditor", "authority", "sensitivity", "evidencePolicy", "activationReady" ] } }, "options": { "type": "object", "properties": { "lists": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "memberCount": { "type": "number" } }, "required": [ "name", "id", "memberCount" ] } }, "segments": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "memberCount": { "type": "number" }, "activeRevisionId": { "type": "string", "nullable": true }, "evaluationStatus": { "type": "string" }, "lastEvaluatedAt": { "type": "string", "nullable": true } }, "required": [ "name", "id", "status", "memberCount", "activeRevisionId", "evaluationStatus", "lastEvaluatedAt" ] } }, "sites": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" } }, "required": [ "name", "id", "status" ] } }, "campaigns": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "state": { "type": "string" } }, "required": [ "name", "id", "state" ] } } }, "required": [ "lists", "segments", "sites", "campaigns" ] }, "sourceHealth": { "type": "object", "properties": { "eventSources": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "siteId": { "type": "string", "nullable": true }, "status": { "type": "string" }, "kind": { "type": "string" }, "key": { "type": "string" }, "healthStatus": { "type": "string" }, "lastError": { "type": "string", "nullable": true }, "providerConnectionId": { "type": "string", "nullable": true }, "lastEventAt": { "type": "string", "nullable": true } }, "required": [ "id", "siteId", "status", "kind", "key", "healthStatus", "lastError", "providerConnectionId", "lastEventAt" ] } }, "connections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "displayName": { "type": "string" }, "healthStatus": { "type": "string" }, "lastErrorCode": { "type": "string", "nullable": true }, "lastCheckedAt": { "type": "string", "nullable": true } }, "required": [ "id", "status", "displayName", "healthStatus", "lastErrorCode", "lastCheckedAt" ] } } }, "required": [ "eventSources", "connections" ] }, "excluded": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "reason": { "type": "string" } }, "required": [ "id", "reason" ] } }, "generatedAt": { "type": "string" } }, "required": [ "version", "categories", "entries", "options", "sourceHealth", "excluded", "generatedAt" ] }, "Group19getResponsedefault51": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "evaluationStatus": { "type": "string" }, "memberCount": { "type": "number" }, "activeRevisionId": { "type": "string", "nullable": true }, "draftRevisionId": { "type": "string", "nullable": true }, "definition": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "evaluationStatus", "memberCount", "activeRevisionId", "draftRevisionId", "definition", "createdAt", "updatedAt" ] }, "Group19getParameters50": { "type": "object", "properties": { "segmentId": { "type": "string" } } }, "Group19patchResponsedefault54": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "status": { "type": "string" }, "evaluationStatus": { "type": "string" }, "memberCount": { "type": "number" }, "activeRevisionId": { "type": "string", "nullable": true }, "draftRevisionId": { "type": "string", "nullable": true }, "definition": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "id", "name", "description", "status", "evaluationStatus", "memberCount", "activeRevisionId", "draftRevisionId", "definition", "createdAt", "updatedAt" ] }, "Group19patchParameters52": { "type": "object", "properties": { "segmentId": { "type": "string" } } }, "Group19patchBody53": { "type": "object", "properties": { "expectedDraftVersion": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string", "nullable": true }, "definition": { "type": "object", "properties": { "version": { "type": "number", "enum": [ 1 ] }, "root": { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "group" ] }, "operator": { "type": "string", "enum": [ "and", "or" ] }, "children": { "type": "array", "items": { "oneOf": [ {}, { "type": "object", "properties": { "id": { "type": "string" }, "kind": { "type": "string", "enum": [ "condition" ] }, "source": { "type": "string", "enum": [ "event", "campaign", "site", "profile", "commerce", "segment", "property", "subscription", "consent", "suppression", "preference", "reachability", "list", "commerce_journey", "engagement", "attribution" ] }, "catalogId": { "type": "string" }, "field": { "type": "string" }, "key": { "type": "string" }, "dataType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "propertyType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "channel": { "type": "string", "enum": [ "push", "email", "sms", "whatsapp" ] }, "purpose": { "type": "string" }, "status": { "type": "string" }, "scope": { "type": "string" }, "scopeKey": { "type": "string" }, "listId": { "type": "string" }, "segmentId": { "type": "string" }, "siteId": { "type": "string" }, "campaignId": { "type": "string" }, "metricId": { "type": "string" }, "metricVersionId": { "type": "string" }, "metricKey": { "type": "string" }, "eventName": { "type": "string" }, "eventFamily": { "type": "string" }, "eventPropertyFilters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "dataType": { "type": "string", "enum": [ "number", "boolean", "text", "list", "identifier", "money", "date_time", "enum" ] }, "operator": { "type": "string", "enum": [ "contains", "in", "lt", "lte", "gt", "gte", "eq", "neq", "not_contains", "starts_with", "ends_with", "not_in", "between", "before", "after", "exists", "not_exists", "missing", "is_empty", "is_not_empty" ] }, "value": {} }, "required": [ "key", "dataType", "operator" ], "x-schema-name": "SegmentPropertyFilter" } }, "occurrence": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "at_least", "at_most", "exactly", "zero" ] }, "count": { "type": "number" } }, "required": [ "mode", "count" ] }, "aggregate": { "type": "object", "properties": { "operation": { "type": "string", "enum": [ "count", "sum", "min", "max", "average" ] }, "property": { "type": "string" } }, "required": [ "operation" ] }, "timeframe": { "oneOf": [ { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "all_time" ] } }, "required": [ "mode" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "relative" ] }, "amount": { "type": "number" }, "unit": { "type": "string", "enum": [ "minutes", "hours", "days", "weeks", "months" ] } }, "required": [ "mode", "amount", "unit" ] }, { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "absolute" ] }, "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "mode", "from", "to" ] } ] }, "timeframeDays": { "type": "number" }, "journey": { "type": "string", "enum": [ "checkout_abandoned", "browse_abandoned", "did_without" ] }, "delayMinutes": { "type": "number" }, "funnel": { "type": "object", "properties": { "steps": { "type": "array", "items": { "type": "object", "properties": { "metricId": { "type": "string" }, "metricVersionId": { "type": "string" }, "eventFamily": { "type": "string" } }, "required": [ "metricId", "metricVersionId", "eventFamily" ] } }, "maxDelayMinutes": { "type": "number" } }, "required": [ "steps", "maxDelayMinutes" ] }, "operator": { "type": "string", "enum": [ "contains", "in", "lt", "lte", "gt", "gte", "eq", "neq", "not_contains", "starts_with", "ends_with", "not_in", "between", "before", "after", "exists", "not_exists", "missing", "is_empty", "is_not_empty" ] }, "value": {} }, "required": [ "id", "kind", "source", "operator" ], "x-schema-name": "SegmentCondition" } ] } } }, "required": [ "id", "kind", "operator", "children" ], "x-schema-name": "SegmentGroup" } }, "required": [ "version", "root" ], "x-schema-name": "SegmentDefinition" } }, "required": [ "expectedDraftVersion" ] }, "Group19postResponse20257": { "type": "object", "properties": { "segmentId": { "type": "string" }, "status": { "type": "string" }, "revisionId": { "type": "string" }, "evaluationId": { "type": "string" }, "evaluationStatus": { "type": "string" } }, "required": [ "segmentId", "status", "revisionId", "evaluationId", "evaluationStatus" ] }, "Group19postParameters55": { "type": "object", "properties": { "segmentId": { "type": "string" } } }, "Group19postBody56": { "type": "object", "properties": { "expectedDraftVersion": { "type": "number" } }, "required": [ "expectedDraftVersion" ] }, "Group19getResponsedefault59": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string" }, "status": { "type": "string" }, "key": { "type": "string" }, "version": { "type": "number" }, "eventName": { "type": "string" }, "governance": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "activatedAt": { "type": "string", "nullable": true } }, "required": [ "id", "type", "status", "key", "version", "eventName", "governance", "activatedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters58": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getResponsedefault61": { "type": "object", "properties": { "id": { "type": "string" }, "updatedAt": { "type": "string" }, "status": { "type": "string" }, "traceId": { "type": "string", "nullable": true }, "receivedAt": { "type": "string" }, "envelope": { "type": "object", "properties": { "occurredAt": { "type": "string" }, "eventName": { "type": "string" }, "eventId": { "type": "string" } }, "required": [ "occurredAt", "eventName", "eventId" ], "nullable": true }, "dispatches": { "type": "array", "items": { "type": "object", "properties": { "updatedAt": { "type": "string" }, "status": { "type": "string" }, "destination": { "type": "string" } }, "required": [ "updatedAt", "status", "destination" ] } } }, "required": [ "id", "updatedAt", "status", "traceId", "receivedAt", "envelope", "dispatches" ] }, "Group19getParameters60": { "type": "object", "properties": { "receiptId": { "type": "string" } } }, "Group19getResponsedefault63": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "updatedAt": { "type": "string" }, "status": { "type": "string" }, "description": { "type": "string", "nullable": true }, "metrics": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "dimensions": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "name", "id", "updatedAt", "status", "description", "metrics", "dimensions" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters62": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getResponsedefault65": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "updatedAt": { "type": "string" }, "description": { "type": "string", "nullable": true }, "revision": { "type": "number" }, "dataViews": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "metricKey": { "type": "string" }, "visualization": { "type": "string" } }, "required": [ "id", "title", "metricKey", "visualization" ] } } }, "required": [ "name", "id", "updatedAt", "description", "revision", "dataViews" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters64": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getResponsedefault68": { "oneOf": [ { "type": "object", "properties": { "dashboardRevision": { "type": "number" }, "cardId": { "type": "string" }, "siteId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "number" } }, "required": [ "value" ] } }, "metric": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "unit": { "type": "string" }, "definition": { "type": "string" }, "version": { "type": "number" } }, "required": [ "key", "label", "unit", "definition", "version" ] }, "dimensions": { "type": "array", "items": { "type": "string" } }, "window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "freshness": { "type": "object", "properties": { "latestReceivedAt": { "type": "string", "nullable": true }, "state": { "type": "string" } }, "required": [ "latestReceivedAt", "state" ] }, "currency": { "type": "object", "properties": { "mode": { "type": "string" }, "values": {} }, "required": [ "mode", "values" ] }, "generatedAt": { "type": "string" }, "reportingTimezone": { "type": "string" } }, "required": [ "dashboardRevision", "cardId", "siteId", "data", "metric", "dimensions", "window", "freshness", "currency", "generatedAt", "reportingTimezone" ] }, { "type": "object", "properties": { "dashboardRevision": { "type": "number" }, "cardId": { "type": "string" }, "siteId": { "type": "string" }, "metric": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "orders", "event_count", "unique_visitors", "sessions", "session_duration", "active_engagement", "bounce_rate", "pages_per_visit", "unique_profiles", "revenue", "average_order_value", "form_submission_rate", "web_vital_p75", "numeric_property_sum", "numeric_property_average" ] }, "version": { "type": "number" }, "label": { "type": "string" }, "unit": { "type": "string" }, "definition": { "type": "string" } }, "required": [ "key", "version", "label", "unit", "definition" ] }, "dimensions": { "type": "array", "items": {} }, "shape": { "type": "string", "enum": [ "funnel", "journey", "cohort", "geo", "distribution", "scatter", "realtime", "hierarchy" ] }, "kind": { "type": "string", "enum": [ "funnel", "journey", "cohort", "geo", "distribution", "scatter", "realtime", "hierarchy" ] }, "definitionVersion": { "type": "number", "enum": [ 1 ] }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {}, {}, { "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } }, { "type": "object" } ], "nullable": true }, "x-schema-name": "JSONObject" }, {} ], "nullable": true } } }, "window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "reportingTimezone": { "type": "string" }, "generatedAt": { "type": "string" }, "freshness": { "type": "object", "properties": { "latestReceivedAt": { "type": "string", "nullable": true }, "state": { "type": "string", "enum": [ "empty", "stale", "ready" ] } }, "required": [ "latestReceivedAt", "state" ] }, "quality": { "type": "object", "properties": { "state": { "type": "string", "enum": [ "complete", "partial" ] }, "excludedActors": { "type": "number" }, "unknownDimensions": { "type": "number" } }, "required": [ "state", "excludedActors", "unknownDimensions" ] }, "currency": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "not_applicable", "mixed", "single" ] }, "values": {} }, "required": [ "mode", "values" ] }, "privacy": { "type": "object", "properties": { "aggregation": { "type": "string", "enum": [ "consent_permitted" ] }, "excludedFields": { "type": "array", "items": { "oneOf": [ { "type": "string", "enum": [ "ip" ] }, { "type": "string", "enum": [ "precise_location" ] }, { "type": "string", "enum": [ "query_string" ] }, { "type": "string", "enum": [ "fingerprint" ] } ] }, "minItems": 4, "maxItems": 4 } }, "required": [ "aggregation", "excludedFields" ] } }, "required": [ "dashboardRevision", "cardId", "siteId", "metric", "dimensions", "shape", "kind", "definitionVersion", "data", "window", "reportingTimezone", "generatedAt", "freshness", "quality", "currency", "privacy" ] }, { "type": "object", "properties": { "dashboardRevision": { "type": "number" }, "cardId": { "type": "string" }, "siteId": { "type": "string" }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } } }, "metric": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "unit": { "type": "string" }, "definition": { "type": "string" }, "version": { "type": "number" } }, "required": [ "key", "label", "unit", "definition", "version" ] }, "dimensions": {}, "window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "freshness": { "type": "object", "properties": { "latestReceivedAt": { "type": "string", "nullable": true }, "state": { "type": "string" } }, "required": [ "latestReceivedAt", "state" ] }, "currency": { "type": "object", "properties": { "mode": { "type": "string" }, "values": {}, "reportingCurrency": { "type": "string" }, "reportingState": { "type": "string" } }, "required": [ "mode", "values" ] }, "generatedAt": { "type": "string" }, "reportingTimezone": { "type": "string" } }, "required": [ "dashboardRevision", "cardId", "siteId", "data", "metric", "dimensions", "window", "freshness", "currency", "generatedAt", "reportingTimezone" ] }, { "type": "object", "properties": { "dashboardRevision": { "type": "number" }, "cardId": { "type": "string" }, "siteId": { "type": "string" }, "comparison": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } } }, "window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] } }, "required": [ "data", "window" ] }, "data": { "type": "array", "items": { "type": "object", "additionalProperties": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, {} ], "nullable": true } } }, "metric": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "unit": { "type": "string" }, "definition": { "type": "string" }, "version": { "type": "number" } }, "required": [ "key", "label", "unit", "definition", "version" ] }, "dimensions": {}, "window": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" } }, "required": [ "from", "to" ] }, "freshness": { "type": "object", "properties": { "latestReceivedAt": { "type": "string", "nullable": true }, "state": { "type": "string" } }, "required": [ "latestReceivedAt", "state" ] }, "currency": { "type": "object", "properties": { "mode": { "type": "string" }, "values": {}, "reportingCurrency": { "type": "string" }, "reportingState": { "type": "string" } }, "required": [ "mode", "values" ] }, "generatedAt": { "type": "string" }, "reportingTimezone": { "type": "string" } }, "required": [ "dashboardRevision", "cardId", "siteId", "comparison", "data", "metric", "dimensions", "window", "freshness", "currency", "generatedAt", "reportingTimezone" ] } ] }, "Group19getParameters66": { "type": "object", "properties": { "from": { "type": "string" }, "to": { "type": "string" }, "reportingTimezone": { "type": "string" } } }, "Group19getParameters67": { "type": "object", "properties": { "dashboardId": { "type": "string" }, "cardId": { "type": "string" } } }, "Group19getResponsedefault71": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "provider": { "type": "string" }, "cancelledAt": { "type": "string", "nullable": true }, "items": { "type": "array", "items": { "type": "object", "properties": { "title": { "type": "string" }, "sku": { "type": "string", "nullable": true }, "quantity": { "type": "number" }, "unitPrice": { "type": "string" }, "totalAmount": { "type": "string" }, "variantTitle": { "type": "string", "nullable": true } }, "required": [ "title", "sku", "quantity", "unitPrice", "totalAmount", "variantTitle" ] } }, "currency": { "type": "string" }, "totalAmount": { "type": "string" }, "orderNumber": { "type": "string", "nullable": true }, "placedAt": { "type": "string" }, "fulfillmentState": { "type": "string" }, "fulfilledAt": { "type": "string", "nullable": true }, "deliveredAt": { "type": "string", "nullable": true }, "refundedAt": { "type": "string", "nullable": true } }, "required": [ "id", "status", "provider", "cancelledAt", "items", "currency", "totalAmount", "orderNumber", "placedAt", "fulfillmentState", "fulfilledAt", "deliveredAt", "refundedAt" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters69": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getParameters70": { "type": "object", "properties": { "profileId": { "type": "string" } } }, "Group19getResponsedefault72": { "type": "object", "properties": { "version": { "type": "string", "enum": [ "billing_view_v1" ] }, "organization": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ] }, "account": { "type": "object", "properties": { "state": { "type": "string" }, "mode": { "type": "string", "enum": [ "test", "live" ], "nullable": true }, "ready": { "type": "boolean" }, "providerAvailable": { "type": "boolean" }, "razorpayAvailable": { "type": "boolean" }, "razorpayEnabled": { "type": "boolean" }, "paymentProvider": { "type": "string", "enum": [ "stripe", "razorpay" ], "nullable": true }, "aiUsageUnlimited": { "type": "boolean" }, "reconciliationDelayed": { "type": "boolean" }, "lastReconciledAt": { "type": "string", "nullable": true } }, "required": [ "state", "mode", "ready", "providerAvailable", "razorpayAvailable", "razorpayEnabled", "paymentProvider", "aiUsageUnlimited", "reconciliationDelayed", "lastReconciledAt" ] }, "plan": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "isFree": { "type": "boolean" }, "offerKey": { "type": "string", "nullable": true }, "price": { "type": "object", "properties": { "amountMinor": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amountMinor", "currency" ], "nullable": true }, "interval": { "type": "string", "nullable": true }, "intervalCount": { "type": "number", "nullable": true } }, "required": [ "key", "name", "isFree", "offerKey", "price", "interval", "intervalCount" ] }, "subscription": { "type": "object", "properties": { "status": { "type": "string" }, "currentPeriodStart": { "type": "string" }, "currentPeriodEnd": { "type": "string" }, "cancelAtPeriodEnd": { "type": "boolean" }, "cancelAt": { "type": "string", "nullable": true }, "paymentActionRequired": { "type": "boolean" }, "inGrace": { "type": "boolean" } }, "required": [ "status", "currentPeriodStart", "currentPeriodEnd", "cancelAtPeriodEnd", "cancelAt", "paymentActionRequired", "inGrace" ], "nullable": true }, "meters": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "unit": { "type": "string" }, "includedQuantity": { "type": "string" }, "purchasedAvailableQuantity": { "type": "string" }, "reservedQuantity": { "type": "string" }, "consumedQuantity": { "type": "string" }, "effectiveRemainingQuantity": { "type": "string" }, "cycleStart": { "type": "string" }, "cycleEnd": { "type": "string" }, "reconciling": { "type": "boolean" }, "lastReconciledAt": { "type": "string", "nullable": true } }, "required": [ "key", "label", "unit", "includedQuantity", "purchasedAvailableQuantity", "reservedQuantity", "consumedQuantity", "effectiveRemainingQuantity", "cycleStart", "cycleEnd", "reconciling", "lastReconciledAt" ] } }, "invoices": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "number": { "type": "string", "nullable": true }, "status": { "type": "string" }, "amount": { "type": "object", "properties": { "amountMinor": { "type": "number" }, "currency": { "type": "string" } }, "required": [ "amountMinor", "currency" ] }, "createdAt": { "type": "string" } }, "required": [ "id", "number", "status", "amount", "createdAt" ] } } }, "required": [ "version", "organization", "account", "plan", "subscription", "meters", "invoices" ] }, "Group19getResponsedefault74": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "scope": { "type": "string" }, "versions": { "type": "array", "items": { "type": "object", "properties": { "version": { "type": "number" }, "publishedAt": { "type": "string" }, "defaultSubject": { "type": "string" } }, "required": [ "version", "publishedAt", "defaultSubject" ] } }, "goal": { "type": "string" } }, "required": [ "name", "id", "category", "description", "tags", "scope", "versions", "goal" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters73": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponse20176": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "id": { "type": "string" }, "status": { "type": "string" }, "draftVersion": { "type": "number" } }, "required": [ "duplicate", "id", "status", "draftVersion" ] }, "Group19postBody75": { "type": "object", "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "goal": { "type": "string" }, "document": { "type": "object", "additionalProperties": {} }, "defaultSubject": { "type": "string" }, "defaultPreheader": { "type": "string" }, "brandingMode": { "type": "string", "enum": [ "template", "workspace" ] }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "category", "description", "goal", "document", "defaultSubject", "defaultPreheader", "brandingMode" ] }, "Group19getResponsedefault86": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "status": { "type": "string" }, "draft": { "type": "object", "properties": { "status": { "type": "string" }, "version": { "type": "number" }, "document": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "defaultSubject": { "type": "string" }, "defaultPreheader": { "type": "string" }, "brandingMode": { "type": "string" }, "validationReport": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "status", "version", "document", "defaultSubject", "defaultPreheader", "brandingMode", "validationReport" ], "nullable": true }, "category": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "goal": { "type": "string" } }, "required": [ "name", "id", "status", "draft", "category", "description", "tags", "goal" ] }, "Group19getParameters85": { "type": "object", "properties": { "templateId": { "type": "string" } } }, "Group19putResponsedefault89": { "type": "object", "properties": { "templateId": { "type": "string" }, "version": { "type": "number" }, "status": { "type": "string" }, "validationReport": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "templateId", "version", "status", "validationReport" ] }, "Group19putParameters87": { "type": "object", "properties": { "templateId": { "type": "string" } } }, "Group19putBody88": { "type": "object", "properties": { "document": { "type": "object", "additionalProperties": {} }, "defaultSubject": { "type": "string" }, "defaultPreheader": { "type": "string" }, "brandingMode": { "type": "string", "enum": [ "template", "workspace" ] }, "expectedVersion": { "type": "number" }, "name": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "goal": { "type": "string" } }, "required": [ "document", "defaultSubject", "defaultPreheader", "brandingMode", "expectedVersion" ] }, "Group19postResponse20191": { "type": "object", "properties": { "templateId": { "type": "string" }, "version": { "type": "number" }, "status": { "type": "string" } }, "required": [ "templateId", "version", "status" ] }, "Group19postParameters90": { "type": "object", "properties": { "version": { "type": "string" }, "templateId": { "type": "string" } } }, "Group19postResponse20194": { "oneOf": [ { "type": "object", "properties": { "duplicate": { "type": "boolean" } }, "required": [ "duplicate" ] }, { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "id": { "type": "string" }, "templateId": { "type": "string" }, "version": { "type": "number" }, "status": { "type": "string" }, "contentHash": { "type": "string" }, "rendererVersion": { "type": "string" }, "publishedAt": { "type": "string" } }, "required": [ "duplicate", "id", "templateId", "version", "status", "contentHash", "rendererVersion", "publishedAt" ] } ] }, "Group19postParameters92": { "type": "object", "properties": { "templateId": { "type": "string" } } }, "Group19postBody93": { "type": "object", "properties": { "expectedVersion": { "type": "number" } }, "required": [ "expectedVersion" ] }, "Group19getResponsedefault78": { "type": "object", "properties": { "name": { "type": "string" }, "category": { "type": "string" }, "version": { "type": "number" }, "description": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } }, "publishedAt": { "type": "string" }, "goal": { "type": "string" }, "templateId": { "type": "string" }, "document": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "defaultSubject": { "type": "string" }, "defaultPreheader": { "type": "string" }, "contentHash": { "type": "string" } }, "required": [ "name", "category", "version", "description", "tags", "publishedAt", "goal", "templateId", "document", "defaultSubject", "defaultPreheader", "contentHash" ] }, "Group19getParameters77": { "type": "object", "properties": { "version": { "type": "string" }, "templateId": { "type": "string" } } }, "Group19getResponsedefault96": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "state": { "type": "string" }, "revisions": { "type": "array", "items": { "type": "object", "properties": { "state": { "type": "string" }, "revision": { "type": "number" }, "draftVersion": { "type": "number" }, "validationResult": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "state", "revision", "draftVersion", "validationResult" ] } }, "goal": { "type": "string" } }, "required": [ "name", "id", "createdAt", "updatedAt", "state", "revisions", "goal" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters95": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19postResponse20198": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "id": { "type": "string" }, "state": { "type": "string" }, "revision": { "type": "number" }, "draftVersion": { "type": "number" } }, "required": [ "duplicate", "id", "state", "revision", "draftVersion" ] }, "Group19postBody97": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "goal": { "type": "string", "enum": [ "newsletter", "product_promotion", "sale", "exclusive_offer", "business_announcement" ] }, "emailTemplateId": { "type": "string", "minLength": 1 }, "emailTemplateVersion": { "type": "integer", "minimum": 1 }, "scratchDocument": { "type": "object", "additionalProperties": {} }, "scratchSubject": { "type": "string", "minLength": 1, "maxLength": 200 }, "scratchPreheader": { "type": "string", "maxLength": 140 }, "blueprintId": { "type": "string", "minLength": 1 }, "blueprintVersion": { "type": "integer", "minimum": 1 } }, "required": [ "name", "goal" ], "additionalProperties": false, "x-schema-name": "createBody" }, "Group19getResponsedefault100": { "type": "object", "properties": { "name": { "type": "string" }, "id": { "type": "string" }, "state": { "type": "string" }, "revisions": { "type": "array", "items": { "type": "object", "properties": { "emailTemplateVersion": { "type": "number" }, "state": { "type": "string" }, "revision": { "type": "number" }, "draftVersion": { "type": "number" }, "validationResult": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "senderName": { "type": "string" }, "document": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "emailTemplateId": { "type": "string" }, "audienceDefinition": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "senderMailboxId": { "type": "string" }, "subjectVariants": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "schedulePolicy": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "emailTemplateVersion", "state", "revision", "draftVersion", "validationResult", "senderName", "document", "emailTemplateId", "audienceDefinition", "senderMailboxId", "subjectVariants", "schedulePolicy" ] } }, "goal": { "type": "string" }, "runs": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "state": { "type": "string" } }, "required": [ "id", "createdAt", "state" ] } } }, "required": [ "name", "id", "state", "revisions", "goal", "runs" ] }, "Group19getParameters99": { "type": "object", "properties": { "campaignId": { "type": "string" } } }, "Group19putResponsedefault103": { "type": "object", "properties": { "revision": { "type": "number" }, "draftVersion": { "type": "number" }, "validationResult": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "state": { "type": "string" } }, "required": [ "revision", "draftVersion", "validationResult", "state" ] }, "Group19putParameters101": { "type": "object", "properties": { "campaignId": { "type": "string" } } }, "Group19putBody102": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0 }, "document": { "type": "object", "additionalProperties": {} }, "audienceDefinition": { "type": "object", "properties": { "include": { "type": "object", "properties": { "listIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 100, "default": [] }, "segmentIds": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 100, "default": [] } }, "additionalProperties": false }, "exclude": { "$ref": "#/components/schemas/Group19putBody102/properties/audienceDefinition/properties/include" } }, "required": [ "include", "exclude" ], "additionalProperties": false }, "recipientTimingMode": { "type": "string", "enum": [ "snapshot_at_schedule", "determine_at_send_time" ] }, "senderMailboxId": { "type": "string", "maxLength": 200 }, "replyToMailboxId": { "type": "string", "minLength": 1, "nullable": true }, "senderName": { "type": "string", "maxLength": 120 }, "subjectVariants": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "A", "B" ] }, "subject": { "type": "string", "minLength": 1, "maxLength": 200 }, "preheader": { "type": "string", "maxLength": 140 }, "weight": { "type": "integer", "minimum": 1, "maximum": 100 } }, "required": [ "key", "subject", "preheader", "weight" ], "additionalProperties": false }, "minItems": 1, "maxItems": 2 }, "schedulePolicy": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "send_now", "fixed", "recipient_local" ] }, "scheduledAt": { "type": "string", "format": "date-time", "nullable": true, "default": null }, "localDate": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "nullable": true, "default": null }, "localTime": { "type": "string", "pattern": "^\\d{2}:\\d{2}$", "nullable": true, "default": null }, "timeZone": { "type": "string", "minLength": 1, "maxLength": 100, "default": "Asia/Kolkata" }, "passedLocalTimePolicy": { "type": "string", "enum": [ "send_immediately", "following_day" ], "nullable": true, "default": null } }, "required": [ "mode" ], "additionalProperties": false }, "trackingPolicy": { "type": "object", "properties": { "delivery": { "type": "boolean", "default": true }, "clicks": { "type": "boolean", "default": true }, "opens": { "type": "boolean", "default": true }, "utm": { "type": "object", "properties": { "source": { "type": "string", "maxLength": 100, "default": "fendsy" }, "medium": { "type": "string", "maxLength": 100, "default": "email" }, "campaign": { "type": "string", "maxLength": 200, "default": "" }, "content": { "type": "string", "maxLength": 200, "default": "" } }, "additionalProperties": false } }, "required": [ "utm" ], "additionalProperties": false }, "attributionPolicy": { "type": "object", "properties": { "model": { "type": "string", "enum": [ "click_first" ], "default": "click_first" }, "clickWindowHours": { "type": "integer", "minimum": 1, "maximum": 720, "default": 120 }, "openFallbackHours": { "type": "integer", "minimum": 1, "maximum": 168, "default": 24 } }, "additionalProperties": false }, "guardrailPolicy": { "type": "object", "properties": { "frequencyCapDays": { "type": "integer", "minimum": 0, "maximum": 90, "default": 0 }, "recentRecipientDays": { "type": "integer", "minimum": 0, "maximum": 90, "default": 0 }, "largeSendThreshold": { "type": "integer", "minimum": 100, "maximum": 10000000, "default": 10000 }, "largeSendConfirmed": { "type": "boolean", "default": false } }, "additionalProperties": false }, "abTest": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "samplePercent": { "type": "integer", "minimum": 2, "maximum": 100, "default": 100 }, "holdoutPercent": { "type": "integer", "minimum": 0, "maximum": 98, "default": 0 }, "winnerRule": { "type": "string", "enum": [ "open_rate", "click_rate" ], "default": "click_rate" }, "winnerEvaluationAt": { "type": "string", "format": "date-time", "nullable": true, "default": null } }, "additionalProperties": false, "nullable": true } }, "required": [ "expectedVersion", "document", "audienceDefinition", "recipientTimingMode", "senderMailboxId", "replyToMailboxId", "senderName", "subjectVariants", "schedulePolicy", "trackingPolicy", "attributionPolicy", "guardrailPolicy", "abTest" ], "additionalProperties": false, "x-schema-name": "revisionBody" }, "Group19postResponsedefault106": { "type": "object", "properties": { "revision": { "type": "number" }, "state": { "type": "string" }, "validationResult": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true } }, "required": [ "revision", "state", "validationResult" ] }, "Group19postParameters104": { "type": "object", "properties": { "campaignId": { "type": "string" } } }, "Group19postBody105": { "type": "object", "properties": { "expectedVersion": { "type": "integer", "minimum": 0 } }, "required": [ "expectedVersion" ], "additionalProperties": false, "x-schema-name": "readyBody" }, "Group19postResponse202109": { "type": "object", "properties": { "runId": { "type": "string" }, "state": { "type": "string" }, "scheduledAt": { "type": "string", "nullable": true }, "revisionId": { "type": "string" } }, "required": [ "runId", "state", "scheduledAt", "revisionId" ] }, "Group19postParameters107": { "type": "object", "properties": { "campaignId": { "type": "string" } } }, "Group19postBody108": { "type": "object", "properties": {}, "additionalProperties": false, "x-schema-name": "emptyBody" }, "Group19getResponsedefault114": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "state": { "type": "string" }, "scheduledAt": { "type": "string", "nullable": true }, "totalCount": { "type": "number" }, "eligibleCount": { "type": "number" }, "sentCount": { "type": "number" }, "deliveredCount": { "type": "number" }, "failedCount": { "type": "number" } }, "required": [ "id", "createdAt", "state", "scheduledAt", "totalCount", "eligibleCount", "sentCount", "deliveredCount", "failedCount" ] } }, "nextCursor": { "type": "string", "nullable": true } }, "required": [ "items", "nextCursor" ] }, "Group19getParameters112": { "type": "object", "properties": { "limit": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "cursor": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] } } }, "Group19getParameters113": { "type": "object", "properties": { "campaignId": { "type": "string" } } }, "Group19getResponsedefault111": { "type": "object", "properties": { "id": { "type": "string" }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" }, "state": { "type": "string" }, "revisionId": { "type": "string" }, "startedAt": { "type": "string", "nullable": true }, "scheduledAt": { "type": "string", "nullable": true }, "campaignId": { "type": "string" }, "totalCount": { "type": "number" }, "eligibleCount": { "type": "number" }, "queuedCount": { "type": "number" }, "sentCount": { "type": "number" }, "deliveredCount": { "type": "number" }, "bouncedCount": { "type": "number" }, "complainedCount": { "type": "number" }, "unsubscribedCount": { "type": "number" }, "openedCount": { "type": "number" }, "clickedCount": { "type": "number" }, "failedCount": { "type": "number" }, "eligibilitySummary": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, { "type": "array", "items": {} }, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "failureSummary": { "oneOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean", "enum": [ false ] }, { "type": "boolean", "enum": [ true ] }, {}, { "type": "object", "additionalProperties": {} } ], "nullable": true }, "finishedAt": { "type": "string", "nullable": true } }, "required": [ "id", "createdAt", "updatedAt", "state", "revisionId", "startedAt", "scheduledAt", "campaignId", "totalCount", "eligibleCount", "queuedCount", "sentCount", "deliveredCount", "bouncedCount", "complainedCount", "unsubscribedCount", "openedCount", "clickedCount", "failedCount", "eligibilitySummary", "failureSummary", "finishedAt" ] }, "Group19getParameters110": { "type": "object", "properties": { "campaignId": { "type": "string" }, "runId": { "type": "string" } } }, "Group19postResponsedefault117": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "runId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "duplicate", "runId", "state" ] }, "Group19postParameters115": { "type": "object", "properties": { "campaignId": { "type": "string" }, "runId": { "type": "string" }, "action": { "type": "string" } } }, "Group19postBody116": { "type": "object", "properties": {}, "additionalProperties": false, "x-schema-name": "emptyBody" }, "Group19postResponsedefault119": { "oneOf": [ { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "duplicate": { "type": "boolean" } }, "required": [ "id", "status", "duplicate" ] }, { "type": "object", "properties": { "id": { "type": "string" }, "status": { "type": "string" }, "duplicate": { "type": "boolean" }, "validationErrors": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "path": { "type": "string" }, "message": { "type": "string" } }, "required": [ "code", "path", "message" ] } }, "providerReceiptId": { "type": "string" } }, "required": [ "id", "status", "duplicate", "validationErrors", "providerReceiptId" ] } ] }, "Group19postBody118": { "anyOf": [ { "type": "object", "properties": { "siteId": { "type": "string", "minLength": 1, "maxLength": 200 }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "type": "string", "format": "date-time" }, "kind": { "type": "string", "enum": [ "account_created" ] } }, "required": [ "siteId", "customerProfileId", "accountId", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "kind": { "type": "string", "enum": [ "email_verified" ] } }, "required": [ "siteId", "customerProfileId", "accountId", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "kind": { "type": "string", "enum": [ "workspace_created" ] }, "workspaceId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" } }, "required": [ "siteId", "customerProfileId", "accountId", "kind", "workspaceId" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "kind": { "type": "string", "enum": [ "trial_started" ] }, "planId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "trialEndsAt": { "type": "string", "format": "date-time" } }, "required": [ "siteId", "customerProfileId", "accountId", "kind", "planId", "trialEndsAt" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "kind": { "type": "string", "enum": [ "trial_ended" ] }, "planId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" } }, "required": [ "siteId", "customerProfileId", "accountId", "kind", "planId" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "planId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "subscriptionId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "kind": { "type": "string", "enum": [ "plan_activated" ] } }, "required": [ "siteId", "customerProfileId", "accountId", "planId", "subscriptionId", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "planId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "subscriptionId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "kind": { "type": "string", "enum": [ "plan_renewed" ] } }, "required": [ "siteId", "customerProfileId", "accountId", "planId", "subscriptionId", "kind" ], "additionalProperties": false }, { "type": "object", "properties": { "siteId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "customerProfileId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "accountId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "occurredAt": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/occurredAt" }, "planId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "subscriptionId": { "$ref": "#/components/schemas/Group19postBody118/anyOf/0/properties/siteId" }, "kind": { "type": "string", "enum": [ "plan_cancelled" ] } }, "required": [ "siteId", "customerProfileId", "accountId", "planId", "subscriptionId", "kind" ], "additionalProperties": false } ], "x-schema-name": "saasEventBody" }, "Group19postResponse20280": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "deliveryId": { "type": "string" }, "state": { "type": "string" }, "dispatchId": { "type": "string" }, "templateId": { "type": "string" }, "version": { "type": "number" }, "customerProfileId": { "type": "string" } }, "required": [ "duplicate", "deliveryId", "state", "dispatchId", "templateId", "version", "customerProfileId" ] }, "Group19postBody79": { "type": "object", "properties": { "version": { "type": "number" }, "customerProfileId": { "type": "string" }, "templateId": { "type": "string" }, "orderId": { "type": "string" } }, "required": [ "version", "customerProfileId", "templateId" ] }, "Group19postResponse20282": { "type": "object", "properties": { "duplicate": { "type": "boolean" }, "deliveryId": { "type": "string" }, "state": { "type": "string" }, "dispatchId": { "type": "string" }, "templateId": { "type": "string" }, "version": { "type": "number" }, "customerProfileId": { "type": "string" } }, "required": [ "duplicate", "deliveryId", "state", "dispatchId", "templateId", "version", "customerProfileId" ] }, "Group19postBody81": { "type": "object", "properties": { "version": { "type": "number" }, "customerProfileId": { "type": "string" }, "orderId": { "type": "string" }, "templateId": { "type": "string" }, "reason": { "type": "string", "enum": [ "order_confirmation" ] } }, "required": [ "version", "customerProfileId", "orderId", "templateId", "reason" ] }, "Group19getResponsedefault84": { "type": "object", "properties": { "deliveryId": { "type": "string" }, "state": { "type": "string" }, "providerState": { "type": "string" }, "providerMessageId": { "type": "string", "nullable": true }, "customerProfileId": { "type": "string", "nullable": true }, "createdAt": { "type": "string" }, "updatedAt": { "type": "string" } }, "required": [ "deliveryId", "state", "providerState", "providerMessageId", "customerProfileId", "createdAt", "updatedAt" ] }, "Group19getParameters83": { "type": "object", "properties": { "deliveryId": { "type": "string" } } } }, "responses": { "BadRequest": { "description": "The request is invalid or cannot be completed.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Unauthorized": { "description": "Authentication is required or invalid.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Forbidden": { "description": "The caller is not allowed to perform this operation.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "RateLimited": { "description": "The endpoint rate limit was exceeded.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "InternalError": { "description": "An unexpected server error occurred.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "ServiceUnavailable": { "description": "A required service is temporarily unavailable.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "Conflict": { "description": "The request conflicts with existing state.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } }, "NotFound": { "description": "The requested resource was not found.", "headers": { "x-request-id": { "description": "Correlation ID returned for support and tracing.", "schema": { "type": "string" } } }, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiError" } } } } } }, "tags": [ { "name": "Authentication" }, { "name": "Sites and identity" }, { "name": "Events" }, { "name": "Catalog" }, { "name": "Orders" }, { "name": "Customer Profiles" }, { "name": "Lists" }, { "name": "Segments" }, { "name": "Analytics" }, { "name": "Customer history" }, { "name": "Billing" }, { "name": "Templates" }, { "name": "Campaigns" }, { "name": "SaaS lifecycle" }, { "name": "Sends" } ] }