{"items":[{"type":"link","label":"Engage API","link":"/engage/openapi","routeSlug":"/engage/openapi","content":{"contentType":"overview","meta":{"name":"Engage API"},"children":[{"nodeType":"container","panels":[{"title":"Download OpenAPI description","titleTranslationKey":"download.description.title","children":[{"kind":"download","label":"openapi.json","url":"/_bundle/engage/openapi.json?download"},{"kind":"download","label":"openapi.yaml","url":"/_bundle/engage/openapi.yaml?download"}]},{"title":"Overview","titleTranslationKey":"info.title","children":[]},{"title":"Languages","titleTranslationKey":"languages.title","children":[{"kind":"languages","options":[{"key":"curl","title":"curl","lang":"curl"},{"key":"javascript","title":"JavaScript","lang":"JavaScript"},{"key":"node","title":"Node.js","lang":"Node.js"},{"key":"python","title":"Python","lang":"Python"},{"key":"java","title":"Java","lang":"Java"},{"key":"csharp","title":"C#","lang":"C#"},{"key":"php","title":"PHP","lang":"PHP"},{"key":"go","title":"Go","lang":"Go"},{"key":"ruby","title":"Ruby","lang":"Ruby"},{"key":"r","title":"R","lang":"R"},{"key":"payload","title":"Payload","lang":"Payload"}]}]},{"title":"Servers","titleTranslationKey":"servers.title","children":[{"kind":"servers","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"mode":"default"}]}],"children":[{"nodeType":"overview-section-wrapper","children":[{"nodeType":"header","level":1,"label":"Engage API (1.0.0)","showPageActions":true},{"nodeType":"overview-section-wrapper","children":[{"nodeType":"markdoc","content":"V1 operation reference for Shuffll Engage. The flat-video-v1 campaign rendering format uses fixed clips; that format-specific restriction does not describe the full Engage product. Discover live workspace capabilities and the MCP tool catalog for available workflows. Access is checked against tenant policy and principal authority."}],"sectionId":"/"}],"sectionId":"/"}]}]}},{"type":"separator","label":"Workspace management","content":null},{"type":"group","label":"Partners","link":"/engage/openapi/partners","routeSlug":"/engage/openapi/partners","items":[{"label":"Create partner","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/partners_provision","routeSlug":"/engage/openapi/partners/partners_provision","metadata":{"seo":{"title":"Create partner — Shuffll Engage API","description":"Shuffll Engage: Provision an inactive partner."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Create partner — Shuffll Engage API","description":"Shuffll Engage: Provision an inactive partner."},"meta":{"sourceId":"partners_provision","name":"Create partner","isWebhook":false,"pointer":"/paths/~1v1~1meta-organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Provision an inactive partner. Owner email and brand mode are required; invitation and activation are separate."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1meta-organizations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1"}},"schemaId":"schema_1","pointer":"/paths/~1v1~1meta-organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/meta-organizations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_1"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/meta-organizations","href":"partners/partners_provision","openApiOperationId":"partners_provision","summary":"Create partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_1","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_1"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1meta-organizations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/partners_provision"}],"panels":[]}]},"httpPath":"/v1/meta-organizations"},{"label":"List partners","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/partners_list","routeSlug":"/engage/openapi/partners/partners_list","metadata":{"seo":{"title":"List partners — Shuffll Engage API","description":"Shuffll Engage: List safe partner metadata with cursor pagination."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List partners — Shuffll Engage API","description":"Shuffll Engage: List safe partner metadata with cursor pagination."},"meta":{"sourceId":"partners_list","name":"List partners","isWebhook":false,"pointer":"/paths/~1v1~1meta-organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List partners","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List safe partner metadata with cursor pagination."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1meta-organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/meta-organizations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/meta-organizations","href":"partners/partners_list","openApiOperationId":"partners_list","summary":"List partners"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}},"schemaId":"schema_12","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1meta-organizations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_12","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_12"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/partners_list"}],"panels":[]}]},"httpPath":"/v1/meta-organizations"},{"label":"Get partner","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/partners_get","routeSlug":"/engage/openapi/partners/partners_get","metadata":{"seo":{"title":"Get partner — Shuffll Engage API","description":"Shuffll Engage: Read safe partner provisioning and activation status."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get partner — Shuffll Engage API","description":"Shuffll Engage: Read safe partner provisioning and activation status."},"meta":{"sourceId":"partners_get","name":"Get partner","isWebhook":false,"pointer":"/paths/~1v1~1meta-organizations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read safe partner provisioning and activation status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1meta-organizations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/meta-organizations/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/meta-organizations/{id}","href":"partners/partners_get","openApiOperationId":"partners_get","summary":"Get partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1meta-organizations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/partners_get"}],"panels":[]}]},"httpPath":"/v1/meta-organizations/{id}"},{"label":"Update partner","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/partners_update","routeSlug":"/engage/openapi/partners/partners_update","metadata":{"seo":{"title":"Update partner — Shuffll Engage API","description":"Shuffll Engage: Update partner metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update partner — Shuffll Engage API","description":"Shuffll Engage: Update partner metadata."},"meta":{"sourceId":"partners_update","name":"Update partner","isWebhook":false,"pointer":"/paths/~1v1~1meta-organizations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update partner","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update partner metadata. Custom domain remains metadata only."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1meta-organizations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1meta-organizations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"schemaId":"schema_16","pointer":"/paths/~1v1~1meta-organizations~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/meta-organizations/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_16"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/meta-organizations/{id}","href":"partners/partners_update","openApiOperationId":"partners_update","summary":"Update partner"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_16","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_16"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1meta-organizations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/partners_update"}],"panels":[]}]},"httpPath":"/v1/meta-organizations/{id}"},{"label":"Set activation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/partners_activate","routeSlug":"/engage/openapi/partners/partners_activate","metadata":{"seo":{"title":"Set activation — Shuffll Engage API","description":"Shuffll Engage: Explicitly activate or deactivate a partner using existing readiness prerequisites."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Set activation — Shuffll Engage API","description":"Shuffll Engage: Explicitly activate or deactivate a partner using existing readiness prerequisites."},"meta":{"sourceId":"partners_activate","name":"Set activation","isWebhook":false,"pointer":"/paths/~1v1~1meta-organizations~1{id}~1activation/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set activation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Explicitly activate or deactivate a partner using existing readiness prerequisites."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1meta-organizations~1{id}~1activation/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1meta-organizations~1{id}~1activation/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"schemaId":"schema_17","pointer":"/paths/~1v1~1meta-organizations~1{id}~1activation/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/meta-organizations/{id}/activation","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_17"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/meta-organizations/{id}/activation","href":"partners/partners_activate","openApiOperationId":"partners_activate","summary":"Set activation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_17","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_17"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1meta-organizations~1{id}~1activation/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/partners_activate"}],"panels":[]}]},"httpPath":"/v1/meta-organizations/{id}/activation"},{"label":"Get current account","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/partners/account_get","routeSlug":"/engage/openapi/partners/account_get","metadata":{"seo":{"title":"Get current account — Shuffll Engage API","description":"Shuffll Engage: Read the current partner account for a partner-level principal."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get current account — Shuffll Engage API","description":"Shuffll Engage: Read the current partner account for a partner-level principal."},"meta":{"sourceId":"account_get","name":"Get current account","isWebhook":false,"pointer":"/paths/~1v1~1account/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get current account","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read the current partner account for a partner-level principal."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/account","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/account","href":"partners/account_get","openApiOperationId":"account_get","summary":"Get current account"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}},"schemaId":"schema_13","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1account/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_13","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_13"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/partners/account_get"}],"panels":[]}]},"httpPath":"/v1/account"}],"content":{"contentType":"group","meta":{"name":"Partners"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Partners","showPageActions":true},{"nodeType":"markdoc","content":"Provision partners and manage their account status."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/meta-organizations","summary":"Create partner","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partners/partners_provision","deprecated":false},{"title":"/v1/meta-organizations","summary":"List partners","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/partners_list","deprecated":false},{"title":"/v1/meta-organizations/{id}","summary":"Get partner","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/partners_get","deprecated":false},{"title":"/v1/meta-organizations/{id}","summary":"Update partner","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/partners/partners_update","deprecated":false},{"title":"/v1/meta-organizations/{id}/activation","summary":"Set activation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/partners/partners_activate","deprecated":false},{"title":"/v1/account","summary":"Get current account","prefix":{"name":"get","color":"get"},"badges":[],"link":"/partners/account_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Organizations","link":"/engage/openapi/organizations","routeSlug":"/engage/openapi/organizations","items":[{"label":"Create organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/organizations/organizations_create","routeSlug":"/engage/openapi/organizations/organizations_create","metadata":{"seo":{"title":"Create organization — Shuffll Engage API","description":"Shuffll Engage: Create a child organization and its brand profile."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Create organization — Shuffll Engage API","description":"Shuffll Engage: Create a child organization and its brand profile."},"meta":{"sourceId":"organizations_create","name":"Create organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Create a child organization and its brand profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1organizations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"schemaId":"schema_18","pointer":"/paths/~1v1~1organizations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_18"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations","href":"organizations/organizations_create","openApiOperationId":"organizations_create","summary":"Create organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_18","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_18"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations_create"}],"panels":[]}]},"httpPath":"/v1/organizations"},{"label":"List organizations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/organizations/organizations_list","routeSlug":"/engage/openapi/organizations/organizations_list","metadata":{"seo":{"title":"List organizations — Shuffll Engage API","description":"Shuffll Engage: List only organizations within the current tenant context."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List organizations — Shuffll Engage API","description":"Shuffll Engage: List only organizations within the current tenant context."},"meta":{"sourceId":"organizations_list","name":"List organizations","isWebhook":false,"pointer":"/paths/~1v1~1organizations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List organizations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List only organizations within the current tenant context."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1organizations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations","href":"organizations/organizations_list","openApiOperationId":"organizations_list","summary":"List organizations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}},"schemaId":"schema_19","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_19","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_19"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations_list"}],"panels":[]}]},"httpPath":"/v1/organizations"},{"label":"Get organization","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/organizations/organizations_get","routeSlug":"/engage/openapi/organizations/organizations_get","metadata":{"seo":{"title":"Get organization — Shuffll Engage API","description":"Shuffll Engage: Read safe organization metadata and revision."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get organization — Shuffll Engage API","description":"Shuffll Engage: Read safe organization metadata and revision."},"meta":{"sourceId":"organizations_get","name":"Get organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read safe organization metadata and revision."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}","href":"organizations/organizations_get","openApiOperationId":"organizations_get","summary":"Get organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}},"schemaId":"schema_20","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_20","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_20"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations_get"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}"},{"label":"Update organization","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/organizations/organizations_update","routeSlug":"/engage/openapi/organizations/organizations_update","metadata":{"seo":{"title":"Update organization — Shuffll Engage API","description":"Shuffll Engage: Update organization name and slug with a current revision."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update organization — Shuffll Engage API","description":"Shuffll Engage: Update organization name and slug with a current revision."},"meta":{"sourceId":"organizations_update","name":"Update organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update organization name and slug with a current revision."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"schemaId":"schema_21","pointer":"/paths/~1v1~1organizations~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/organizations/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_21"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}","href":"organizations/organizations_update","openApiOperationId":"organizations_update","summary":"Update organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_21","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_21"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations_update"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}"},{"label":"Archive organization","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/organizations/organizations_archive","routeSlug":"/engage/openapi/organizations/organizations_archive","metadata":{"seo":{"title":"Archive organization — Shuffll Engage API","description":"Shuffll Engage: Archive a non-default organization."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Archive organization — Shuffll Engage API","description":"Shuffll Engage: Archive a non-default organization."},"meta":{"sourceId":"organizations_archive","name":"Archive organization","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive organization","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Archive a non-default organization. Its history is retained."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1organizations~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/archive","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/archive","href":"organizations/organizations_archive","openApiOperationId":"organizations_archive","summary":"Archive organization"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/organizations/organizations_archive"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/archive"}],"content":{"contentType":"group","meta":{"name":"Organizations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Organizations","showPageActions":true},{"nodeType":"markdoc","content":"Create and manage child workspaces within your tenant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations","summary":"Create organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/organizations_create","deprecated":false},{"title":"/v1/organizations","summary":"List organizations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/organizations_list","deprecated":false},{"title":"/v1/organizations/{id}","summary":"Get organization","prefix":{"name":"get","color":"get"},"badges":[],"link":"/organizations/organizations_get","deprecated":false},{"title":"/v1/organizations/{id}","summary":"Update organization","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/organizations/organizations_update","deprecated":false},{"title":"/v1/organizations/{id}/archive","summary":"Archive organization","prefix":{"name":"post","color":"post"},"badges":[],"link":"/organizations/organizations_archive","deprecated":false}]}]}]}]}},{"type":"group","label":"Branding","link":"/engage/openapi/branding","routeSlug":"/engage/openapi/branding","items":[{"label":"Get branding","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/branding/branding_get","routeSlug":"/engage/openapi/branding/branding_get","metadata":{"seo":{"title":"Get branding — Shuffll Engage API","description":"Shuffll Engage: Read the organization brand profile."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get branding — Shuffll Engage API","description":"Shuffll Engage: Read the organization brand profile."},"meta":{"sourceId":"branding_get","name":"Get branding","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1branding/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get branding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read the organization brand profile."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1branding/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/branding","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}/branding","href":"branding/branding_get","openApiOperationId":"branding_get","summary":"Get branding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}},"schemaId":"schema_23","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1branding/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_23","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_23"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branding/branding_get"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/branding"},{"label":"Update branding","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/branding/branding_update","routeSlug":"/engage/openapi/branding/branding_update","metadata":{"seo":{"title":"Update branding — Shuffll Engage API","description":"Shuffll Engage: Update brand colors, font and verified owned image assets."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update branding — Shuffll Engage API","description":"Shuffll Engage: Update brand colors, font and verified owned image assets."},"meta":{"sourceId":"branding_update","name":"Update branding","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1branding/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update branding","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Update brand colors, font and verified owned image assets."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1branding/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1branding/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"schemaId":"schema_24","pointer":"/paths/~1v1~1organizations~1{id}~1branding/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/organizations/{id}/branding","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_24"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/branding","href":"branding/branding_update","openApiOperationId":"branding_update","summary":"Update branding"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_24","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_24"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1branding/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/branding/branding_update"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/branding"}],"content":{"contentType":"group","meta":{"name":"Branding"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Branding","showPageActions":true},{"nodeType":"markdoc","content":"Read and update workspace branding."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/branding","summary":"Get branding","prefix":{"name":"get","color":"get"},"badges":[],"link":"/branding/branding_get","deprecated":false},{"title":"/v1/organizations/{id}/branding","summary":"Update branding","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/branding/branding_update","deprecated":false}]}]}]}]}},{"type":"group","label":"Members","link":"/engage/openapi/members","routeSlug":"/engage/openapi/members","items":[{"label":"List members","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/members/members_list","routeSlug":"/engage/openapi/members/members_list","metadata":{"seo":{"title":"List members — Shuffll Engage API","description":"Shuffll Engage: List organization memberships."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List members — Shuffll Engage API","description":"Shuffll Engage: List organization memberships."},"meta":{"sourceId":"members_list","name":"List members","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1members/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List members","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List organization memberships."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/members","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}/members","href":"members/members_list","openApiOperationId":"members_list","summary":"List members"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}},"schemaId":"schema_25","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_25","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_25"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_list"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/members"},{"label":"Add member","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/members/members_add","routeSlug":"/engage/openapi/members/members_add","metadata":{"seo":{"title":"Add member — Shuffll Engage API","description":"Shuffll Engage: Add an existing account without sending an invitation."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Add member — Shuffll Engage API","description":"Shuffll Engage: Add an existing account without sending an invitation."},"meta":{"sourceId":"members_add","name":"Add member","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1members/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Add an existing account without sending an invitation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26","pointer":"/paths/~1v1~1organizations~1{id}~1members/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/members","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_26"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/members","href":"members/members_add","openApiOperationId":"members_add","summary":"Add member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1members/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_add"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/members"},{"label":"Update member role","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/members/members_update","routeSlug":"/engage/openapi/members/members_update","metadata":{"seo":{"title":"Update member role — Shuffll Engage API","description":"Shuffll Engage: Change a membership role while protecting the last administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update member role — Shuffll Engage API","description":"Shuffll Engage: Change a membership role while protecting the last administrator."},"meta":{"sourceId":"members_update","name":"Update member role","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update member role","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Change a membership role while protecting the last administrator."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"member_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27"}},"schemaId":"schema_27","pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/organizations/{id}/members/{member_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"member_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_27"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/members/{member_id}","href":"members/members_update","openApiOperationId":"members_update","summary":"Update member role"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_27","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_27"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_update"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/members/{member_id}"},{"label":"Remove member","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/members/members_remove","routeSlug":"/engage/openapi/members/members_remove","metadata":{"seo":{"title":"Remove member — Shuffll Engage API","description":"Shuffll Engage: Remove a membership while protecting the last administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Remove member — Shuffll Engage API","description":"Shuffll Engage: Remove a membership while protecting the last administrator."},"meta":{"sourceId":"members_remove","name":"Remove member","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Remove member","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Remove a membership while protecting the last administrator."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"member_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{id}/members/{member_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"member_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/members/{member_id}","href":"members/members_remove","openApiOperationId":"members_remove","summary":"Remove member"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1members~1{member_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/members/members_remove"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/members/{member_id}"}],"content":{"contentType":"group","meta":{"name":"Members"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Members","showPageActions":true},{"nodeType":"markdoc","content":"Manage workspace membership and roles."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/members","summary":"List members","prefix":{"name":"get","color":"get"},"badges":[],"link":"/members/members_list","deprecated":false},{"title":"/v1/organizations/{id}/members","summary":"Add member","prefix":{"name":"post","color":"post"},"badges":[],"link":"/members/members_add","deprecated":false},{"title":"/v1/organizations/{id}/members/{member_id}","summary":"Update member role","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/members/members_update","deprecated":false},{"title":"/v1/organizations/{id}/members/{member_id}","summary":"Remove member","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/members/members_remove","deprecated":false}]}]}]}]}},{"type":"group","label":"Invitations","link":"/engage/openapi/invitations","routeSlug":"/engage/openapi/invitations","items":[{"label":"Create invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/invitations/invitations_create","routeSlug":"/engage/openapi/invitations/invitations_create","metadata":{"seo":{"title":"Create invitation — Shuffll Engage API","description":"Shuffll Engage: Explicitly invite an account."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Create invitation — Shuffll Engage API","description":"Shuffll Engage: Explicitly invite an account."},"meta":{"sourceId":"invitations_create","name":"Create invitation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Explicitly invite an account. Membership begins only after acceptance."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"schemaId":"schema_26","pointer":"/paths/~1v1~1organizations~1{id}~1invitations/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/invitations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_26"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/invitations","href":"invitations/invitations_create","openApiOperationId":"invitations_create","summary":"Create invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_26","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_26"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/invitations_create"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/invitations"},{"label":"List invitations","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/invitations/invitations_list","routeSlug":"/engage/openapi/invitations/invitations_list","metadata":{"seo":{"title":"List invitations — Shuffll Engage API","description":"Shuffll Engage: List scoped invitation status."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List invitations — Shuffll Engage API","description":"Shuffll Engage: List scoped invitation status."},"meta":{"sourceId":"invitations_list","name":"List invitations","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List invitations","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List scoped invitation status."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/invitations","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}/invitations","href":"invitations/invitations_list","openApiOperationId":"invitations_list","summary":"List invitations"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}},"schemaId":"schema_28","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_28","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_28"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/invitations_list"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/invitations"},{"label":"Get invitation","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/invitations/invitations_get","routeSlug":"/engage/openapi/invitations/invitations_get","metadata":{"seo":{"title":"Get invitation — Shuffll Engage API","description":"Shuffll Engage: Read an invitation without sending mail."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get invitation — Shuffll Engage API","description":"Shuffll Engage: Read an invitation without sending mail."},"meta":{"sourceId":"invitations_get","name":"Get invitation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read an invitation without sending mail."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"invitation_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/invitations/{invitation_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"invitation_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}/invitations/{invitation_id}","href":"invitations/invitations_get","openApiOperationId":"invitations_get","summary":"Get invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}},"schemaId":"schema_29","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_29","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_29"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/invitations_get"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/invitations/{invitation_id}"},{"label":"Revoke invitation","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/invitations/invitations_revoke","routeSlug":"/engage/openapi/invitations/invitations_revoke","metadata":{"seo":{"title":"Revoke invitation — Shuffll Engage API","description":"Shuffll Engage: Revoke a pending invitation."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Revoke invitation — Shuffll Engage API","description":"Shuffll Engage: Revoke a pending invitation."},"meta":{"sourceId":"invitations_revoke","name":"Revoke invitation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke a pending invitation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"invitation_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/organizations/{id}/invitations/{invitation_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"invitation_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/invitations/{invitation_id}","href":"invitations/invitations_revoke","openApiOperationId":"invitations_revoke","summary":"Revoke invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/invitations_revoke"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/invitations/{invitation_id}"},{"label":"Resend invitation","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/invitations/invitations_resend","routeSlug":"/engage/openapi/invitations/invitations_resend","metadata":{"seo":{"title":"Resend invitation — Shuffll Engage API","description":"Shuffll Engage: Explicitly resend an invitation with a known prior delivery outcome."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Resend invitation — Shuffll Engage API","description":"Shuffll Engage: Explicitly resend an invitation with a known prior delivery outcome."},"meta":{"sourceId":"invitations_resend","name":"Resend invitation","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}~1resend/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Resend invitation","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Explicitly resend an invitation with a known prior delivery outcome."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"invitation_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}~1resend/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}~1resend/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}~1resend/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/organizations/{id}/invitations/{invitation_id}/resend","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"invitation_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/invitations/{invitation_id}/resend","href":"invitations/invitations_resend","openApiOperationId":"invitations_resend","summary":"Resend invitation"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1invitations~1{invitation_id}~1resend/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/invitations/invitations_resend"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/invitations/{invitation_id}/resend"}],"content":{"contentType":"group","meta":{"name":"Invitations"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Invitations","showPageActions":true},{"nodeType":"markdoc","content":"Invite accounts and manage pending invitations."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/invitations","summary":"Create invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invitations/invitations_create","deprecated":false},{"title":"/v1/organizations/{id}/invitations","summary":"List invitations","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invitations/invitations_list","deprecated":false},{"title":"/v1/organizations/{id}/invitations/{invitation_id}","summary":"Get invitation","prefix":{"name":"get","color":"get"},"badges":[],"link":"/invitations/invitations_get","deprecated":false},{"title":"/v1/organizations/{id}/invitations/{invitation_id}","summary":"Revoke invitation","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/invitations/invitations_revoke","deprecated":false},{"title":"/v1/organizations/{id}/invitations/{invitation_id}/resend","summary":"Resend invitation","prefix":{"name":"post","color":"post"},"badges":[],"link":"/invitations/invitations_resend","deprecated":false}]}]}]}]}},{"type":"separator","label":"Content library","content":null},{"type":"group","label":"Uploads","link":"/engage/openapi/uploads","routeSlug":"/engage/openapi/uploads","items":[{"label":"Create upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/uploads/uploads_create","routeSlug":"/engage/openapi/uploads/uploads_create","metadata":{"seo":{"title":"Create upload — Shuffll Engage API","description":"Create a private PNG/JPEG/WebP upload (1–10485760 bytes). Finalize within 15 minutes; signed PUT capability lasts 2 hours and cannot overwrite. No remote URL ingestion."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Create upload — Shuffll Engage API","description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Shuffll Engage: Create a private PNG/JPEG/WebP upload (1–10485760 bytes)."},"children":[],"type":"text"}],"type":"paragraph"}]},"meta":{"sourceId":"uploads_create","name":"Create upload","isWebhook":false,"pointer":"/paths/~1v1~1uploads/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Create a private PNG/JPEG/WebP upload (1–10485760 bytes). Finalize within 15 minutes; signed PUT capability lasts 2 hours and cannot overwrite. No remote URL ingestion."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1uploads/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30"}},"schemaId":"schema_30","pointer":"/paths/~1v1~1uploads/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uploads","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_30"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/uploads","href":"uploads/uploads_create","openApiOperationId":"uploads_create","summary":"Create upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_30","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_30"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}},"schemaId":"schema_31","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1uploads/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"202","schemaId":"schema_31","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_31"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uploads/uploads_create"}],"panels":[]}]},"httpPath":"/v1/uploads"},{"label":"Get upload","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/uploads/uploads_get","routeSlug":"/engage/openapi/uploads/uploads_get","metadata":{"seo":{"title":"Get upload — Shuffll Engage API","description":"Shuffll Engage: Read upload status and finalization deadline."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get upload — Shuffll Engage API","description":"Shuffll Engage: Read upload status and finalization deadline."},"meta":{"sourceId":"uploads_get","name":"Get upload","isWebhook":false,"pointer":"/paths/~1v1~1uploads~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read upload status and finalization deadline. Revocation/expiry blocks finalization but does not revoke an already issued 2-hour storage capability."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1uploads~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/uploads/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/uploads/{id}","href":"uploads/uploads_get","openApiOperationId":"uploads_get","summary":"Get upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}},"schemaId":"schema_32","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1uploads~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_32","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_32"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uploads/uploads_get"}],"panels":[]}]},"httpPath":"/v1/uploads/{id}"},{"label":"Revoke upload","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/uploads/uploads_revoke","routeSlug":"/engage/openapi/uploads/uploads_revoke","metadata":{"seo":{"title":"Revoke upload — Shuffll Engage API","description":"Shuffll Engage: Revoke an unfinished upload session."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Revoke upload — Shuffll Engage API","description":"Shuffll Engage: Revoke an unfinished upload session."},"meta":{"sourceId":"uploads_revoke","name":"Revoke upload","isWebhook":false,"pointer":"/paths/~1v1~1uploads~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke an unfinished upload session. Existing storage PUT capability still lasts up to 2 hours; finalization is denied."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1uploads~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1uploads~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/uploads/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/uploads/{id}","href":"uploads/uploads_revoke","openApiOperationId":"uploads_revoke","summary":"Revoke upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1uploads~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uploads/uploads_revoke"}],"panels":[]}]},"httpPath":"/v1/uploads/{id}"},{"label":"Finalize upload","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/uploads/uploads_finalize","routeSlug":"/engage/openapi/uploads/uploads_finalize","metadata":{"seo":{"title":"Finalize upload — Shuffll Engage API","description":"Shuffll Engage: Verify completed owned object size, raster bytes and MIME, then atomically create a private ready asset."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Finalize upload — Shuffll Engage API","description":"Shuffll Engage: Verify completed owned object size, raster bytes and MIME, then atomically create a private ready asset."},"meta":{"sourceId":"uploads_finalize","name":"Finalize upload","isWebhook":false,"pointer":"/paths/~1v1~1uploads~1{id}~1finalize/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Finalize upload","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Verify completed owned object size, raster bytes and MIME, then atomically create a private ready asset."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1uploads~1{id}~1finalize/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1uploads~1{id}~1finalize/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1uploads~1{id}~1finalize/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/uploads/{id}/finalize","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/uploads/{id}/finalize","href":"uploads/uploads_finalize","openApiOperationId":"uploads_finalize","summary":"Finalize upload"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1uploads~1{id}~1finalize/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/uploads/uploads_finalize"}],"panels":[]}]},"httpPath":"/v1/uploads/{id}/finalize"}],"content":{"contentType":"group","meta":{"name":"Uploads"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Uploads","showPageActions":true},{"nodeType":"markdoc","content":"Create, finalize and revoke private image uploads."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/uploads","summary":"Create upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/uploads/uploads_create","deprecated":false},{"title":"/v1/uploads/{id}","summary":"Get upload","prefix":{"name":"get","color":"get"},"badges":[],"link":"/uploads/uploads_get","deprecated":false},{"title":"/v1/uploads/{id}","summary":"Revoke upload","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/uploads/uploads_revoke","deprecated":false},{"title":"/v1/uploads/{id}/finalize","summary":"Finalize upload","prefix":{"name":"post","color":"post"},"badges":[],"link":"/uploads/uploads_finalize","deprecated":false}]}]}]}]}},{"type":"group","label":"Assets","link":"/engage/openapi/assets","routeSlug":"/engage/openapi/assets","items":[{"label":"Get asset","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/assets/assets_get","routeSlug":"/engage/openapi/assets/assets_get","metadata":{"seo":{"title":"Get asset — Shuffll Engage API","description":"Shuffll Engage: Read safe owned asset metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get asset — Shuffll Engage API","description":"Shuffll Engage: Read safe owned asset metadata."},"meta":{"sourceId":"assets_get","name":"Get asset","isWebhook":false,"pointer":"/paths/~1v1~1assets~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get asset","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read safe owned asset metadata. Private storage references and upload capabilities are never returned."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1assets~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/assets/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/assets/{id}","href":"assets/assets_get","openApiOperationId":"assets_get","summary":"Get asset"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}},"schemaId":"schema_33","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1assets~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_33","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_33"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/assets_get"}],"panels":[]}]},"httpPath":"/v1/assets/{id}"},{"label":"List assets","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/assets/assets_list","routeSlug":"/engage/openapi/assets/assets_list","metadata":{"seo":{"title":"List assets — Shuffll Engage API","description":"Shuffll Engage: List owned asset metadata within the current tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List assets — Shuffll Engage API","description":"Shuffll Engage: List owned asset metadata within the current tenant."},"meta":{"sourceId":"assets_list","name":"List assets","isWebhook":false,"pointer":"/paths/~1v1~1assets/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List assets","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List owned asset metadata within the current tenant."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1assets/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/assets","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/assets","href":"assets/assets_list","openApiOperationId":"assets_list","summary":"List assets"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}},"schemaId":"schema_34","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1assets/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_34","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_34"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/assets_list"}],"panels":[]}]},"httpPath":"/v1/assets"},{"label":"Publish branding image","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/assets/assets_promote_branding","routeSlug":"/engage/openapi/assets/assets_promote_branding","metadata":{"seo":{"title":"Publish branding image — Shuffll Engage API","description":"Shuffll Engage: Explicitly publish a verified owned raster image at a durable public branding URL."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Publish branding image — Shuffll Engage API","description":"Shuffll Engage: Explicitly publish a verified owned raster image at a durable public branding URL."},"meta":{"sourceId":"assets_promote_branding","name":"Publish branding image","isWebhook":false,"pointer":"/paths/~1v1~1assets~1{id}~1promote-branding/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Publish branding image","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Explicitly publish a verified owned raster image at a durable public branding URL. The original storage object remains private."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1assets~1{id}~1promote-branding/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1assets~1{id}~1promote-branding/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1assets~1{id}~1promote-branding/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/assets/{id}/promote-branding","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/assets/{id}/promote-branding","href":"assets/assets_promote_branding","openApiOperationId":"assets_promote_branding","summary":"Publish branding image"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1assets~1{id}~1promote-branding/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/assets/assets_promote_branding"}],"panels":[]}]},"httpPath":"/v1/assets/{id}/promote-branding"}],"content":{"contentType":"group","meta":{"name":"Assets"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Assets","showPageActions":true},{"nodeType":"markdoc","content":"Browse owned assets and explicitly publish branding images."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/assets/{id}","summary":"Get asset","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/assets_get","deprecated":false},{"title":"/v1/assets","summary":"List assets","prefix":{"name":"get","color":"get"},"badges":[],"link":"/assets/assets_list","deprecated":false},{"title":"/v1/assets/{id}/promote-branding","summary":"Publish branding image","prefix":{"name":"post","color":"post"},"badges":[],"link":"/assets/assets_promote_branding","deprecated":false}]}]}]}]}},{"type":"group","label":"Catalogs","link":"/engage/openapi/catalogs","routeSlug":"/engage/openapi/catalogs","items":[{"label":"List languages","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_languages","routeSlug":"/engage/openapi/catalogs/catalogs_languages","metadata":{"seo":{"title":"List languages — Shuffll Engage API","description":"Shuffll Engage: Read configured languages available to this tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List languages — Shuffll Engage API","description":"Shuffll Engage: Read configured languages available to this tenant."},"meta":{"sourceId":"catalogs_languages","name":"List languages","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1languages/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List languages","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read configured languages available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_35"}],"pointer":"/paths/~1v1~1catalogs~1languages/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/languages","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/languages","href":"catalogs/catalogs_languages","openApiOperationId":"catalogs_languages","summary":"List languages"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1languages/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_languages"}],"panels":[]}]},"httpPath":"/v1/catalogs/languages"},{"label":"List voices","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_voices","routeSlug":"/engage/openapi/catalogs/catalogs_voices","metadata":{"seo":{"title":"List voices — Shuffll Engage API","description":"Shuffll Engage: Read configured voices available to this tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List voices — Shuffll Engage API","description":"Shuffll Engage: Read configured voices available to this tenant."},"meta":{"sourceId":"catalogs_voices","name":"List voices","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1voices/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List voices","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read configured voices available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1catalogs~1voices/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/voices","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/voices","href":"catalogs/catalogs_voices","openApiOperationId":"catalogs_voices","summary":"List voices"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1voices/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_voices"}],"panels":[]}]},"httpPath":"/v1/catalogs/voices"},{"label":"List fonts","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_fonts","routeSlug":"/engage/openapi/catalogs/catalogs_fonts","metadata":{"seo":{"title":"List fonts — Shuffll Engage API","description":"Shuffll Engage: Read configured fonts available to this tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List fonts — Shuffll Engage API","description":"Shuffll Engage: Read configured fonts available to this tenant."},"meta":{"sourceId":"catalogs_fonts","name":"List fonts","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1fonts/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List fonts","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read configured fonts available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_35"}],"pointer":"/paths/~1v1~1catalogs~1fonts/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/fonts","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/fonts","href":"catalogs/catalogs_fonts","openApiOperationId":"catalogs_fonts","summary":"List fonts"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1fonts/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_fonts"}],"panels":[]}]},"httpPath":"/v1/catalogs/fonts"},{"label":"List music","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_music","routeSlug":"/engage/openapi/catalogs/catalogs_music","metadata":{"seo":{"title":"List music — Shuffll Engage API","description":"Shuffll Engage: Read configured music available to this tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List music — Shuffll Engage API","description":"Shuffll Engage: Read configured music available to this tenant."},"meta":{"sourceId":"catalogs_music","name":"List music","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1music/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List music","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read configured music available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1catalogs~1music/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/music","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/music","href":"catalogs/catalogs_music","openApiOperationId":"catalogs_music","summary":"List music"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1music/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_music"}],"panels":[]}]},"httpPath":"/v1/catalogs/music"},{"label":"List models","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_models","routeSlug":"/engage/openapi/catalogs/catalogs_models","metadata":{"seo":{"title":"List models — Shuffll Engage API","description":"Shuffll Engage: Read configured models available to this tenant."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List models — Shuffll Engage API","description":"Shuffll Engage: Read configured models available to this tenant."},"meta":{"sourceId":"catalogs_models","name":"List models","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1models/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List models","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read configured models available to this tenant. Catalog entries do not grant generation authority. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_35"}],"pointer":"/paths/~1v1~1catalogs~1models/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/models","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/models","href":"catalogs/catalogs_models","openApiOperationId":"catalogs_models","summary":"List models"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1models/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_models"}],"panels":[]}]},"httpPath":"/v1/catalogs/models"},{"label":"List transitions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/catalogs/catalogs_transitions","routeSlug":"/engage/openapi/catalogs/catalogs_transitions","metadata":{"seo":{"title":"List transitions — Shuffll Engage API","description":"Shuffll Engage: Native transition styles with verified playback/export parity."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List transitions — Shuffll Engage API","description":"Shuffll Engage: Native transition styles with verified playback/export parity."},"meta":{"sourceId":"catalogs_transitions","name":"List transitions","isWebhook":false,"pointer":"/paths/~1v1~1catalogs~1transitions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List transitions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Native transition styles with verified playback/export parity. Currently empty; generated transitions are never offered. Stable ID cursor pagination defaults to 50 entries, maximum 100."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_35"}],"pointer":"/paths/~1v1~1catalogs~1transitions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/catalogs/transitions","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_35"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/catalogs/transitions","href":"catalogs/catalogs_transitions","openApiOperationId":"catalogs_transitions","summary":"List transitions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}},"schemaId":"schema_36","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1catalogs~1transitions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_36","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_36"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/catalogs/catalogs_transitions"}],"panels":[]}]},"httpPath":"/v1/catalogs/transitions"}],"content":{"contentType":"group","meta":{"name":"Catalogs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Catalogs","showPageActions":true},{"nodeType":"markdoc","content":"Discover currently configured options available to your tenant."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/catalogs/languages","summary":"List languages","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_languages","deprecated":false},{"title":"/v1/catalogs/voices","summary":"List voices","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_voices","deprecated":false},{"title":"/v1/catalogs/fonts","summary":"List fonts","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_fonts","deprecated":false},{"title":"/v1/catalogs/music","summary":"List music","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_music","deprecated":false},{"title":"/v1/catalogs/models","summary":"List models","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_models","deprecated":false},{"title":"/v1/catalogs/transitions","summary":"List transitions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/catalogs/catalogs_transitions","deprecated":false}]}]}]}]}},{"type":"group","label":"Templates","link":"/engage/openapi/templates","routeSlug":"/engage/openapi/templates","items":[{"label":"List templates","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/templates/templates_list","routeSlug":"/engage/openapi/templates/templates_list","metadata":{"seo":{"title":"List templates — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List templates — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."},"meta":{"sourceId":"templates_list","name":"List templates","isWebhook":false,"pointer":"/paths/~1v1~1templates/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List templates","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1templates/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/templates","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/templates","href":"templates/templates_list","openApiOperationId":"templates_list","summary":"List templates"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}},"schemaId":"schema_37","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1templates/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_37","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_37"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/templates_list"}],"panels":[]}]},"httpPath":"/v1/templates"},{"label":"Get template","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/templates/templates_get","routeSlug":"/engage/openapi/templates/templates_get","metadata":{"seo":{"title":"Get template — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get template — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."},"meta":{"sourceId":"templates_get","name":"Get template","isWebhook":false,"pointer":"/paths/~1v1~1templates~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get template","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1templates~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/templates/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/templates/{id}","href":"templates/templates_get","openApiOperationId":"templates_get","summary":"Get template"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}},"schemaId":"schema_38","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1templates~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_38","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_38"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/templates_get"}],"panels":[]}]},"httpPath":"/v1/templates/{id}"},{"label":"List versions","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/templates/template_versions_list","routeSlug":"/engage/openapi/templates/template_versions_list","metadata":{"seo":{"title":"List versions — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List versions — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."},"meta":{"sourceId":"template_versions_list","name":"List versions","isWebhook":false,"pointer":"/paths/~1v1~1templates~1{id}~1versions/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List versions","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1templates~1{id}~1versions/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1templates~1{id}~1versions/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/templates/{id}/versions","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/templates/{id}/versions","href":"templates/template_versions_list","openApiOperationId":"template_versions_list","summary":"List versions"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}},"schemaId":"schema_39","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1templates~1{id}~1versions/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_39","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_39"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/template_versions_list"}],"panels":[]}]},"httpPath":"/v1/templates/{id}/versions"},{"label":"Get version","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/templates/template_versions_get","routeSlug":"/engage/openapi/templates/template_versions_get","metadata":{"seo":{"title":"Get version — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get version — Shuffll Engage API","description":"Shuffll Engage: Discover authorized published template metadata."},"meta":{"sourceId":"template_versions_get","name":"Get version","isWebhook":false,"pointer":"/paths/~1v1~1templates~1{id}~1versions~1{version_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get version","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Discover authorized published template metadata. Safe projection only; Only explicitly frozen flat-video-v1 versions are render-ready. They contain fixed video clips without personalization; legacy and unsupported versions remain unavailable."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"version_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1templates~1{id}~1versions~1{version_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/templates/{id}/versions/{version_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"version_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/templates/{id}/versions/{version_id}","href":"templates/template_versions_get","openApiOperationId":"template_versions_get","summary":"Get version"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}},"schemaId":"schema_40","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1templates~1{id}~1versions~1{version_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_40","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_40"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/templates/template_versions_get"}],"panels":[]}]},"httpPath":"/v1/templates/{id}/versions/{version_id}"}],"content":{"contentType":"group","meta":{"name":"Templates"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Templates","showPageActions":true},{"nodeType":"markdoc","content":"Discover published templates and their immutable versions."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/templates","summary":"List templates","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/templates_list","deprecated":false},{"title":"/v1/templates/{id}","summary":"Get template","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/templates_get","deprecated":false},{"title":"/v1/templates/{id}/versions","summary":"List versions","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/template_versions_list","deprecated":false},{"title":"/v1/templates/{id}/versions/{version_id}","summary":"Get version","prefix":{"name":"get","color":"get"},"badges":[],"link":"/templates/template_versions_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Video campaigns","content":null},{"type":"group","label":"Campaigns","link":"/engage/openapi/campaigns","routeSlug":"/engage/openapi/campaigns","items":[{"label":"Create campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_create","routeSlug":"/engage/openapi/campaigns/campaigns_create","metadata":{"seo":{"title":"Create campaign — Shuffll Engage API","description":"Create an Engage campaign from an authorized frozen template version. Generation starts through a separate explicit operation."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Create campaign — Shuffll Engage API","description":"Create an Engage campaign from an authorized frozen template version. Generation starts through a separate explicit operation."},"meta":{"sourceId":"campaigns_create","name":"Create campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Create campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1campaigns/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"schemaId":"schema_41","pointer":"/paths/~1v1~1campaigns/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/campaigns","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_41"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns","href":"campaigns/campaigns_create","openApiOperationId":"campaigns_create","summary":"Create campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_41","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_41"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_create"}],"panels":[]}]},"httpPath":"/v1/campaigns"},{"label":"List campaigns","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_list","routeSlug":"/engage/openapi/campaigns/campaigns_list","metadata":{"seo":{"title":"List campaigns — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List campaigns — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_list","name":"List campaigns","isWebhook":false,"pointer":"/paths/~1v1~1campaigns/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List campaigns","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1campaigns/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns","href":"campaigns/campaigns_list","openApiOperationId":"campaigns_list","summary":"List campaigns"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}},"schemaId":"schema_42","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_42","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_42"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_list"}],"panels":[]}]},"httpPath":"/v1/campaigns"},{"label":"Update campaign","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_update","routeSlug":"/engage/openapi/campaigns/campaigns_update","metadata":{"seo":{"title":"Update campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_update","name":"Update campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1v1~1campaigns~1{id}/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/campaigns/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}","href":"campaigns/campaigns_update","openApiOperationId":"campaigns_update","summary":"Update campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_update"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}"},{"label":"Get campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_get","routeSlug":"/engage/openapi/campaigns/campaigns_get","metadata":{"seo":{"title":"Get campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_get","name":"Get campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}","href":"campaigns/campaigns_get","openApiOperationId":"campaigns_get","summary":"Get campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}},"schemaId":"schema_44","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_44","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_44"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_get"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}"},{"label":"Clone campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_clone","routeSlug":"/engage/openapi/campaigns/campaigns_clone","metadata":{"seo":{"title":"Clone campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Clone campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_clone","name":"Clone campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1clone/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Clone campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1clone/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1clone/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"schemaId":"schema_43","pointer":"/paths/~1v1~1campaigns~1{id}~1clone/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/campaigns/{id}/clone","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_43"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/clone","href":"campaigns/campaigns_clone","openApiOperationId":"campaigns_clone","summary":"Clone campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_43","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_43"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1clone/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_clone"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/clone"},{"label":"Archive campaign","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_archive","routeSlug":"/engage/openapi/campaigns/campaigns_archive","metadata":{"seo":{"title":"Archive campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Archive campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_archive","name":"Archive campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1archive/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Archive campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1archive/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"schemaId":"schema_22","pointer":"/paths/~1v1~1campaigns~1{id}~1archive/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/campaigns/{id}/archive","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_22"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/archive","href":"campaigns/campaigns_archive","openApiOperationId":"campaigns_archive","summary":"Archive campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_22","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_22"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1archive/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_archive"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/archive"},{"label":"Validate campaign","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/campaigns/campaigns_validate","routeSlug":"/engage/openapi/campaigns/campaigns_validate","metadata":{"seo":{"title":"Validate campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Validate campaign — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaigns_validate","name":"Validate campaign","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1validate/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Validate campaign","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1validate/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/validate","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/validate","href":"campaigns/campaigns_validate","openApiOperationId":"campaigns_validate","summary":"Validate campaign"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}},"schemaId":"schema_45","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1validate/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_45","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_45"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/campaigns/campaigns_validate"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/validate"}],"content":{"contentType":"group","meta":{"name":"Campaigns"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Campaigns","showPageActions":true},{"nodeType":"markdoc","content":"Create, configure and coordinate campaigns from published template versions. See each operation for rendering format and generation requirements."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/campaigns","summary":"Create campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/campaigns_create","deprecated":false},{"title":"/v1/campaigns","summary":"List campaigns","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/campaigns_list","deprecated":false},{"title":"/v1/campaigns/{id}","summary":"Update campaign","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/campaigns/campaigns_update","deprecated":false},{"title":"/v1/campaigns/{id}","summary":"Get campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/campaigns_get","deprecated":false},{"title":"/v1/campaigns/{id}/clone","summary":"Clone campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/campaigns_clone","deprecated":false},{"title":"/v1/campaigns/{id}/archive","summary":"Archive campaign","prefix":{"name":"post","color":"post"},"badges":[],"link":"/campaigns/campaigns_archive","deprecated":false},{"title":"/v1/campaigns/{id}/validate","summary":"Validate campaign","prefix":{"name":"get","color":"get"},"badges":[],"link":"/campaigns/campaigns_validate","deprecated":false}]}]}]}]}},{"type":"group","label":"Production settings","link":"/engage/openapi/production-settings","routeSlug":"/engage/openapi/production-settings","items":[{"label":"Update production settings","deprecated":false,"httpVerb":"patch","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/production-settings/campaign_production_update","routeSlug":"/engage/openapi/production-settings/campaign_production_update","metadata":{"seo":{"title":"Update production settings — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Update production settings — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaign_production_update","name":"Update production settings","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1production/patch","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Update production settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1production/patch/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1production/patch/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46"}},"schemaId":"schema_46","pointer":"/paths/~1v1~1campaigns~1{id}~1production/patch/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PATCH","path":"/v1/campaigns/{id}/production","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_46"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/production","href":"production-settings/campaign_production_update","openApiOperationId":"campaign_production_update","summary":"Update production settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_46","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_46"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1production/patch/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/production-settings/campaign_production_update"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/production"},{"label":"Get production settings","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/production-settings/campaign_production_get","routeSlug":"/engage/openapi/production-settings/campaign_production_get","metadata":{"seo":{"title":"Get production settings — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get production settings — Shuffll Engage API","description":"Shuffll Engage: Canonical child-owned campaign using an explicitly frozen fixed-video version."},"meta":{"sourceId":"campaign_production_get","name":"Get production settings","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1production/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get production settings","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Canonical child-owned campaign using an explicitly frozen fixed-video version. No personalization or automatic generation, export or sending. Workspace materialization remains pending until explicit generation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1production/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/production","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/production","href":"production-settings/campaign_production_get","openApiOperationId":"campaign_production_get","summary":"Get production settings"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}},"schemaId":"schema_47","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1production/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_47","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_47"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/production-settings/campaign_production_get"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/production"}],"content":{"contentType":"group","meta":{"name":"Production settings"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Production settings","showPageActions":true},{"nodeType":"markdoc","content":"Read and update campaign production settings."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/campaigns/{id}/production","summary":"Update production settings","prefix":{"name":"patch","color":"patch"},"badges":[],"link":"/production-settings/campaign_production_update","deprecated":false},{"title":"/v1/campaigns/{id}/production","summary":"Get production settings","prefix":{"name":"get","color":"get"},"badges":[],"link":"/production-settings/campaign_production_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Recipients","link":"/engage/openapi/recipients","routeSlug":"/engage/openapi/recipients","items":[{"label":"Add or update recipients","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/recipients/recipients_upsert","routeSlug":"/engage/openapi/recipients/recipients_upsert","metadata":{"seo":{"title":"Add or update recipients — Shuffll Engage API","description":"Manage Engage campaign recipient records. Adding names or contact details does not generate, personalize, or send videos."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Add or update recipients — Shuffll Engage API","description":"Manage Engage campaign recipient records. Adding names or contact details does not generate, personalize, or send videos."},"meta":{"sourceId":"recipients_upsert","name":"Add or update recipients","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Add or update recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"schemaId":"schema_48","pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/campaigns/{id}/recipients","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_48"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/recipients","href":"recipients/recipients_upsert","openApiOperationId":"recipients_upsert","summary":"Add or update recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_48","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_48"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipients/recipients_upsert"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/recipients"},{"label":"List recipients","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/recipients/recipients_list","routeSlug":"/engage/openapi/recipients/recipients_list","metadata":{"seo":{"title":"List recipients — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List recipients — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."},"meta":{"sourceId":"recipients_list","name":"List recipients","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List recipients","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/recipients","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/recipients","href":"recipients/recipients_list","openApiOperationId":"recipients_list","summary":"List recipients"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}},"schemaId":"schema_49","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_49","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_49"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipients/recipients_list"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/recipients"},{"label":"Delete recipient","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/recipients/recipients_delete","routeSlug":"/engage/openapi/recipients/recipients_delete","metadata":{"seo":{"title":"Delete recipient — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Delete recipient — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."},"meta":{"sourceId":"recipients_delete","name":"Delete recipient","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Delete recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"recipient_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/campaigns/{id}/recipients/{recipient_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"recipient_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/recipients/{recipient_id}","href":"recipients/recipients_delete","openApiOperationId":"recipients_delete","summary":"Delete recipient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipients/recipients_delete"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/recipients/{recipient_id}"},{"label":"Get recipient","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/recipients/recipients_get","routeSlug":"/engage/openapi/recipients/recipients_get","metadata":{"seo":{"title":"Get recipient — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get recipient — Shuffll Engage API","description":"Shuffll Engage: Manage canonical campaign recipients without generation, personalization or sending."},"meta":{"sourceId":"recipients_get","name":"Get recipient","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get recipient","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Manage canonical campaign recipients without generation, personalization or sending. external_id maps to the existing campaign employee identity. Mutations require the campaign revision. Claimed, rendered, sent or otherwise active recipients cannot be edited or deleted. Contact details appear only in authorized recipient reads; mutation results contain indexed status metadata."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"recipient_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/recipients/{recipient_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"recipient_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/recipients/{recipient_id}","href":"recipients/recipients_get","openApiOperationId":"recipients_get","summary":"Get recipient"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}},"schemaId":"schema_50","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1recipients~1{recipient_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_50","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_50"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/recipients/recipients_get"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/recipients/{recipient_id}"}],"content":{"contentType":"group","meta":{"name":"Recipients"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Recipients","showPageActions":true},{"nodeType":"markdoc","content":"Manage campaign recipients without generating or sending videos."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/campaigns/{id}/recipients","summary":"Add or update recipients","prefix":{"name":"post","color":"post"},"badges":[],"link":"/recipients/recipients_upsert","deprecated":false},{"title":"/v1/campaigns/{id}/recipients","summary":"List recipients","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recipients/recipients_list","deprecated":false},{"title":"/v1/campaigns/{id}/recipients/{recipient_id}","summary":"Delete recipient","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/recipients/recipients_delete","deprecated":false},{"title":"/v1/campaigns/{id}/recipients/{recipient_id}","summary":"Get recipient","prefix":{"name":"get","color":"get"},"badges":[],"link":"/recipients/recipients_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Generation","link":"/engage/openapi/generation","routeSlug":"/engage/openapi/generation","items":[{"label":"Generate videos","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/generation/campaigns_generate","routeSlug":"/engage/openapi/generation/campaigns_generate","metadata":{"seo":{"title":"Generate videos — Shuffll Engage API","description":"Render fixed clips with the legacy flat-video-v1 Engage campaign operation. Recipient fields do not personalize the video."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Generate videos — Shuffll Engage API","description":"Render fixed clips with the legacy flat-video-v1 Engage campaign operation. Recipient fields do not personalize the video."},"meta":{"sourceId":"campaigns_generate","name":"Generate videos","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1generate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generate videos","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Render fixed video for 1–100 explicitly selected recipients from the immutable campaign revision. Names are contact metadata, not personalization. Durable idempotency; poll jobs and results. Does not send messages."},"children":[],"type":"text"}],"type":"paragraph"}]},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1generate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1generate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"schemaId":"schema_51","pointer":"/paths/~1v1~1campaigns~1{id}~1generate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/campaigns/{id}/generate","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_51"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/campaigns/{id}/generate","href":"generation/campaigns_generate","openApiOperationId":"campaigns_generate","summary":"Generate videos"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_51","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_51"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1generate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/generation/campaigns_generate"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/generate"}],"content":{"contentType":"group","meta":{"name":"Generation"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Generation","showPageActions":true},{"nodeType":"markdoc","content":"Explicitly start video generation for selected recipients."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/campaigns/{id}/generate","summary":"Generate videos","prefix":{"name":"post","color":"post"},"badges":[],"link":"/generation/campaigns_generate","deprecated":false}]}]}]}]}},{"type":"group","label":"Results","link":"/engage/openapi/results","routeSlug":"/engage/openapi/results","items":[{"label":"List results","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/results/campaign_results_list","routeSlug":"/engage/openapi/results/campaign_results_list","metadata":{"seo":{"title":"List results — Shuffll Engage API","description":"Shuffll Engage: Read recipient render attempts, including failures and pending recovery."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List results — Shuffll Engage API","description":"Shuffll Engage: Read recipient render attempts, including failures and pending recovery."},"meta":{"sourceId":"campaign_results_list","name":"List results","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1results/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List results","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read recipient render attempts, including failures and pending recovery. Media URLs are returned only to authorized readers."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1results/get/parameters"},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1results/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/results","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/results","href":"results/campaign_results_list","openApiOperationId":"campaign_results_list","summary":"List results"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52"}},"schemaId":"schema_52","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1results/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_52","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_52"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/results/campaign_results_list"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/results"},{"label":"Get result","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/results/campaign_results_get","routeSlug":"/engage/openapi/results/campaign_results_get","metadata":{"seo":{"title":"Get result — Shuffll Engage API","description":"Shuffll Engage: Read one exact recipient render attempt and its playable MP4 and timed thumbnails."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get result — Shuffll Engage API","description":"Shuffll Engage: Read one exact recipient render attempt and its playable MP4 and timed thumbnails."},"meta":{"sourceId":"campaign_results_get","name":"Get result","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1results~1{result_id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get result","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read one exact recipient render attempt and its playable MP4 and timed thumbnails."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true},{"name":"result_id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1results~1{result_id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/results/{result_id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"},{"name":"result_id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/results/{result_id}","href":"results/campaign_results_get","openApiOperationId":"campaign_results_get","summary":"Get result"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}},"schemaId":"schema_53","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1results~1{result_id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_53","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_53"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/results/campaign_results_get"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/results/{result_id}"},{"label":"Get analytics","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/results/campaign_analytics_get","routeSlug":"/engage/openapi/results/campaign_analytics_get","metadata":{"seo":{"title":"Get analytics — Shuffll Engage API","description":"Shuffll Engage: Campaign-scoped counts of render attempts and recipients."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get analytics — Shuffll Engage API","description":"Shuffll Engage: Campaign-scoped counts of render attempts and recipients."},"meta":{"sourceId":"campaign_analytics_get","name":"Get analytics","isWebhook":false,"pointer":"/paths/~1v1~1campaigns~1{id}~1analytics/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get analytics","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Campaign-scoped counts of render attempts and recipients. Fixed-video generation does not deliver messages; no engagement or delivery event is inferred from an export."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1campaigns~1{id}~1analytics/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/campaigns/{id}/analytics","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/campaigns/{id}/analytics","href":"results/campaign_analytics_get","openApiOperationId":"campaign_analytics_get","summary":"Get analytics"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}},"schemaId":"schema_54","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1campaigns~1{id}~1analytics/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_54","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_54"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/results/campaign_analytics_get"}],"panels":[]}]},"httpPath":"/v1/campaigns/{id}/analytics"}],"content":{"contentType":"group","meta":{"name":"Results"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Results","showPageActions":true},{"nodeType":"markdoc","content":"Retrieve video results and campaign render analytics."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/campaigns/{id}/results","summary":"List results","prefix":{"name":"get","color":"get"},"badges":[],"link":"/results/campaign_results_list","deprecated":false},{"title":"/v1/campaigns/{id}/results/{result_id}","summary":"Get result","prefix":{"name":"get","color":"get"},"badges":[],"link":"/results/campaign_results_get","deprecated":false},{"title":"/v1/campaigns/{id}/analytics","summary":"Get analytics","prefix":{"name":"get","color":"get"},"badges":[],"link":"/results/campaign_analytics_get","deprecated":false}]}]}]}]}},{"type":"separator","label":"Access and operations","content":null},{"type":"group","label":"API keys","link":"/engage/openapi/api-keys","routeSlug":"/engage/openapi/api-keys","items":[{"label":"List keys","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/api-keys/keys_list","routeSlug":"/engage/openapi/api-keys/keys_list","metadata":{"seo":{"title":"List keys — Shuffll Engage API","description":"Shuffll Engage: List managed credential metadata; verified humans may select an exact managed target."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"List keys — Shuffll Engage API","description":"Shuffll Engage: List managed credential metadata; verified humans may select an exact managed target."},"meta":{"sourceId":"keys_list","name":"List keys","isWebhook":false,"pointer":"/paths/~1v1~1keys/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"List keys","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"List managed credential metadata; verified humans may select an exact managed target."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"limit","in":"query","schemaId":"schema_10"},{"name":"cursor","in":"query","schemaId":"schema_11"},{"name":"level","in":"query","schemaId":"schema_55"},{"name":"metaOrganizationId","in":"query","schemaId":"schema_11"},{"name":"organizationId","in":"query","schemaId":"schema_11"}],"pointer":"/paths/~1v1~1keys/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/keys","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"limit","in":"query","required":false,"schemaId":"schema_10"},{"name":"cursor","in":"query","required":false,"schemaId":"schema_11"},{"name":"level","in":"query","required":false,"schemaId":"schema_55"},{"name":"metaOrganizationId","in":"query","required":false,"schemaId":"schema_11"},{"name":"organizationId","in":"query","required":false,"schemaId":"schema_11"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/keys","href":"api-keys/keys_list","openApiOperationId":"keys_list","summary":"List keys"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}},"schemaId":"schema_56","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1keys/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_56","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_56"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/keys_list"}],"panels":[]}]},"httpPath":"/v1/keys"},{"label":"Issue key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/api-keys/keys_issue","routeSlug":"/engage/openapi/api-keys/keys_issue","metadata":{"seo":{"title":"Issue key — Shuffll Engage API","description":"Shuffll Engage: Issue a scoped credential."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Issue key — Shuffll Engage API","description":"Shuffll Engage: Issue a scoped credential."},"meta":{"sourceId":"keys_issue","name":"Issue key","isWebhook":false,"pointer":"/paths/~1v1~1keys/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Issue key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Issue a scoped credential. MCP returns an authenticated human claim link; REST returns its secret once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1keys/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"schemaId":"schema_57","pointer":"/paths/~1v1~1keys/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/keys","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_57"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/keys","href":"api-keys/keys_issue","openApiOperationId":"keys_issue","summary":"Issue key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_57","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_57"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1keys/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/keys_issue"}],"panels":[]}]},"httpPath":"/v1/keys"},{"label":"Get key","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/api-keys/keys_get","routeSlug":"/engage/openapi/api-keys/keys_get","metadata":{"seo":{"title":"Get key — Shuffll Engage API","description":"Shuffll Engage: Read managed credential metadata and its current revision."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get key — Shuffll Engage API","description":"Shuffll Engage: Read managed credential metadata and its current revision."},"meta":{"sourceId":"keys_get","name":"Get key","isWebhook":false,"pointer":"/paths/~1v1~1keys~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read managed credential metadata and its current revision."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1keys~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/keys/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/keys/{id}","href":"api-keys/keys_get","openApiOperationId":"keys_get","summary":"Get key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}},"schemaId":"schema_58","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1keys~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_58","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_58"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/keys_get"}],"panels":[]}]},"httpPath":"/v1/keys/{id}"},{"label":"Revoke key","deprecated":false,"httpVerb":"delete","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/api-keys/keys_revoke","routeSlug":"/engage/openapi/api-keys/keys_revoke","metadata":{"seo":{"title":"Revoke key — Shuffll Engage API","description":"Shuffll Engage: Revoke a credential and its delegated lineage."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Revoke key — Shuffll Engage API","description":"Shuffll Engage: Revoke a credential and its delegated lineage."},"meta":{"sourceId":"keys_revoke","name":"Revoke key","isWebhook":false,"pointer":"/paths/~1v1~1keys~1{id}/delete","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Revoke key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Revoke a credential and its delegated lineage."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1keys~1{id}/delete/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1keys~1{id}/delete/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"DELETE","path":"/v1/keys/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/keys/{id}","href":"api-keys/keys_revoke","openApiOperationId":"keys_revoke","summary":"Revoke key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1keys~1{id}/delete/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/keys_revoke"}],"panels":[]}]},"httpPath":"/v1/keys/{id}"},{"label":"Rotate key","deprecated":false,"httpVerb":"post","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/api-keys/keys_rotate","routeSlug":"/engage/openapi/api-keys/keys_rotate","metadata":{"seo":{"title":"Rotate key — Shuffll Engage API","description":"Shuffll Engage: Rotate a credential with bounded overlap."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Rotate key — Shuffll Engage API","description":"Shuffll Engage: Rotate a credential with bounded overlap."},"meta":{"sourceId":"keys_rotate","name":"Rotate key","isWebhook":false,"pointer":"/paths/~1v1~1keys~1{id}~1rotate/post","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Rotate key","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Rotate a credential with bounded overlap. MCP returns an authenticated human claim link; REST returns its secret once."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1keys~1{id}~1rotate/post/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1keys~1{id}~1rotate/post/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"schemaId":"schema_59","pointer":"/paths/~1v1~1keys~1{id}~1rotate/post/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"POST","path":"/v1/keys/{id}/rotate","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_59"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/keys/{id}/rotate","href":"api-keys/keys_rotate","openApiOperationId":"keys_rotate","summary":"Rotate key"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_59","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_59"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1keys~1{id}~1rotate/post/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/api-keys/keys_rotate"}],"panels":[]}]},"httpPath":"/v1/keys/{id}/rotate"}],"content":{"contentType":"group","meta":{"name":"API keys"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"API keys","showPageActions":true},{"nodeType":"markdoc","content":"Issue, inspect, rotate and revoke scoped credentials."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/keys","summary":"List keys","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/keys_list","deprecated":false},{"title":"/v1/keys","summary":"Issue key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/keys_issue","deprecated":false},{"title":"/v1/keys/{id}","summary":"Get key","prefix":{"name":"get","color":"get"},"badges":[],"link":"/api-keys/keys_get","deprecated":false},{"title":"/v1/keys/{id}","summary":"Revoke key","prefix":{"name":"delete","color":"delete"},"badges":[],"link":"/api-keys/keys_revoke","deprecated":false},{"title":"/v1/keys/{id}/rotate","summary":"Rotate key","prefix":{"name":"post","color":"post"},"badges":[],"link":"/api-keys/keys_rotate","deprecated":false}]}]}]}]}},{"type":"group","label":"Access policies","link":"/engage/openapi/access-policies","routeSlug":"/engage/openapi/access-policies","items":[{"label":"Get organization access","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/access-policies/organization_access_get","routeSlug":"/engage/openapi/access-policies/organization_access_get","metadata":{"seo":{"title":"Get organization access — Shuffll Engage API","description":"Shuffll Engage: Read child access settings as a partner administrator."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get organization access — Shuffll Engage API","description":"Shuffll Engage: Read child access settings as a partner administrator."},"meta":{"sourceId":"organization_access_get","name":"Get organization access","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1access/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get organization access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read child access settings as a partner administrator."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1access/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/organizations/{id}/access","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/organizations/{id}/access","href":"access-policies/organization_access_get","openApiOperationId":"organization_access_get","summary":"Get organization access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}},"schemaId":"schema_60","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_14"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1access/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_60","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_60"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policies/organization_access_get"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/access"},{"label":"Set organization access","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/access-policies/organization_access_set","routeSlug":"/engage/openapi/access-policies/organization_access_set","metadata":{"seo":{"title":"Set organization access — Shuffll Engage API","description":"Shuffll Engage: Delegate API access within current partner entitlements."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Set organization access — Shuffll Engage API","description":"Shuffll Engage: Delegate API access within current partner entitlements."},"meta":{"sourceId":"organization_access_set","name":"Set organization access","isWebhook":false,"pointer":"/paths/~1v1~1organizations~1{id}~1access/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set organization access","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Delegate API access within current partner entitlements."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1access/put/parameters"},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true},{"name":"If-Match","in":"header","schemaId":"schema_15","description":"Opaque revision from ETag or a job result.","required":true}],"pointer":"/paths/~1v1~1organizations~1{id}~1access/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61"}},"schemaId":"schema_61","pointer":"/paths/~1v1~1organizations~1{id}~1access/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/organizations/{id}/access","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"},{"name":"If-Match","in":"header","required":true,"schemaId":"schema_15"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_61"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/organizations/{id}/access","href":"access-policies/organization_access_set","openApiOperationId":"organization_access_set","summary":"Set organization access"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_61","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_61"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1organizations~1{id}~1access/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policies/organization_access_set"}],"panels":[]}]},"httpPath":"/v1/organizations/{id}/access"},{"label":"Set access policy","deprecated":false,"httpVerb":"put","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/access-policies/api_access_set","routeSlug":"/engage/openapi/access-policies/api_access_set","metadata":{"seo":{"title":"Set access policy — Shuffll Engage API","description":"Shuffll Engage: Human control-plane policy management, including initial activation."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Set access policy — Shuffll Engage API","description":"Shuffll Engage: Human control-plane policy management, including initial activation."},"meta":{"sourceId":"api_access_set","name":"Set access policy","isWebhook":false,"pointer":"/paths/~1v1~1control~1access/put","hasSamples":true},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Set access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Human control-plane policy management, including initial activation."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"headers","label":"Headers","labelTranslationKey":"header","parameters":[{"name":"Idempotency-Key","in":"header","schemaId":"schema_0","description":"Reuse for an uncertain retry of the same intent.","required":true}],"pointer":"/paths/~1v1~1control~1access/put/parameters"},{"nodeType":"item-content","variant":"body","label":"Request Body","labelTranslationKey":"body","required":true,"mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"schemaId":"schema_62","pointer":"/paths/~1v1~1control~1access/put/requestBody"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"PUT","path":"/v1/control/access","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[{"name":"Idempotency-Key","in":"header","required":true,"schemaId":"schema_0"}],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"requestBody":{"application/json":{"schemaId":"schema_62"}},"responseCodes":["200","202","401","405","429","default"],"pointer":"/v1/control/access","href":"access-policies/api_access_set","openApiOperationId":"api_access_set","summary":"Set access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"schemaId":"schema_62","mediaTypes":["application/json"],"mediaTypeSchemas":{"application/json":{"schemaId":"schema_62"}},"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Terminal operation job.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_3"},{"code":"202","description":"Nonterminal operation job; poll Location after Retry-After seconds.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}},"schemaId":"schema_2","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Location":{"required":true,"description":"Absolute URL of the operation job, from the trusted server origin.","schema":{"type":"string","format":"uri"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}},"ETag":{"description":"Quoted opaque revision when the resource or job result has one.","schema":{"type":"string"}}},"headerSchemaId":"schema_4"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1control~1access/put/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"202","schemaId":"schema_2","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_2"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policies/api_access_set"}],"panels":[]}]},"httpPath":"/v1/control/access"},{"label":"Get access policy","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/access-policies/api_access_get","routeSlug":"/engage/openapi/access-policies/api_access_get","metadata":{"seo":{"title":"Get access policy — Shuffll Engage API","description":"Shuffll Engage: Read the stored access policy and safe ancestor ceiling for authorized human administrators."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get access policy — Shuffll Engage API","description":"Shuffll Engage: Read the stored access policy and safe ancestor ceiling for authorized human administrators."},"meta":{"sourceId":"api_access_get","name":"Get access policy","isWebhook":false,"pointer":"/paths/~1v1~1control~1access/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get access policy","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read the stored access policy and safe ancestor ceiling for authorized human administrators."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"query","label":"Query","labelTranslationKey":"query","parameters":[{"name":"level","in":"query","schemaId":"schema_55","required":true},{"name":"metaOrganizationId","in":"query","schemaId":"schema_63"},{"name":"organizationId","in":"query","schemaId":"schema_63"}],"pointer":"/paths/~1v1~1control~1access/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/control/access","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[{"name":"level","in":"query","required":true,"schemaId":"schema_55"},{"name":"metaOrganizationId","in":"query","required":false,"schemaId":"schema_63"},{"name":"organizationId","in":"query","required":false,"schemaId":"schema_63"}],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/control/access","href":"access-policies/api_access_get","openApiOperationId":"api_access_get","summary":"Get access policy"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}},"schemaId":"schema_64","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1control~1access/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_64","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_64"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/access-policies/api_access_get"}],"panels":[]}]},"httpPath":"/v1/control/access"}],"content":{"contentType":"group","meta":{"name":"Access policies"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Access policies","showPageActions":true},{"nodeType":"markdoc","content":"Inspect and administer permitted API access."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/organizations/{id}/access","summary":"Get organization access","prefix":{"name":"get","color":"get"},"badges":[],"link":"/access-policies/organization_access_get","deprecated":false},{"title":"/v1/organizations/{id}/access","summary":"Set organization access","prefix":{"name":"put","color":"put"},"badges":[],"link":"/access-policies/organization_access_set","deprecated":false},{"title":"/v1/control/access","summary":"Set access policy","prefix":{"name":"put","color":"put"},"badges":[],"link":"/access-policies/api_access_set","deprecated":false},{"title":"/v1/control/access","summary":"Get access policy","prefix":{"name":"get","color":"get"},"badges":[],"link":"/access-policies/api_access_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Capabilities","link":"/engage/openapi/capabilities","routeSlug":"/engage/openapi/capabilities","items":[{"label":"Get capabilities","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/capabilities/capabilities_get","routeSlug":"/engage/openapi/capabilities/capabilities_get","metadata":{"seo":{"title":"Get capabilities — Shuffll Engage API","description":"Shuffll Engage: Current safe operations and effective entitlements."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get capabilities — Shuffll Engage API","description":"Shuffll Engage: Current safe operations and effective entitlements."},"meta":{"sourceId":"capabilities_get","name":"Get capabilities","isWebhook":false,"pointer":"/paths/~1v1~1capabilities/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get capabilities","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Current safe operations and effective entitlements."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/capabilities","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/capabilities","href":"capabilities/capabilities_get","openApiOperationId":"capabilities_get","summary":"Get capabilities"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}},"schemaId":"schema_65","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1capabilities/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_65","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_65"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/capabilities/capabilities_get"}],"panels":[]}]},"httpPath":"/v1/capabilities"}],"content":{"contentType":"group","meta":{"name":"Capabilities"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Capabilities","showPageActions":true},{"nodeType":"markdoc","content":"Discover the operations available to the current principal."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/capabilities","summary":"Get capabilities","prefix":{"name":"get","color":"get"},"badges":[],"link":"/capabilities/capabilities_get","deprecated":false}]}]}]}]}},{"type":"group","label":"Jobs","link":"/engage/openapi/jobs","routeSlug":"/engage/openapi/jobs","items":[{"label":"Get job","deprecated":false,"httpVerb":"get","isAdditionalOperation":false,"isWebhook":false,"type":"link","link":"/engage/openapi/jobs/jobs_get","routeSlug":"/engage/openapi/jobs/jobs_get","metadata":{"seo":{"title":"Get job — Shuffll Engage API","description":"Shuffll Engage: Read an initiated operation after checking its underlying workflow authority."}},"content":{"contentType":"item","itemVariant":"httpItem","seo":{"title":"Get job — Shuffll Engage API","description":"Shuffll Engage: Read an initiated operation after checking its underlying workflow authority."},"meta":{"sourceId":"jobs_get","name":"Get job","isWebhook":false,"pointer":"/paths/~1v1~1jobs~1{id}/get","hasSamples":false},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Get job","isWebhook":false,"showPageActions":true}],"panels":[]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Request","labelTranslationKey":"request","deepLinkSuffix":"request"},{"nodeType":"markdoc","content":"Read an initiated operation after checking its underlying workflow authority."},{"nodeType":"security","requirements":[{"schemes":[{"name":"bearerAuth","scopes":[],"type":"http","scheme":"bearer"}]}]},{"nodeType":"item-content","variant":"path","label":"Path","labelTranslationKey":"path","parameters":[{"name":"id","in":"path","schemaId":"schema_11","required":true}],"pointer":"/paths/~1v1~1jobs~1{id}/get/parameters"}],"panels":[{"children":[{"kind":"code-sample","source":{"kind":"code-sample","operationType":"http","method":"GET","path":"/v1/jobs/{id}","servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"parameters":{"path":[{"name":"id","in":"path","required":true,"schemaId":"schema_11"}],"query":[],"querystring":[],"header":[],"cookie":[]},"security":[{"schemes":[{"id":"bearerAuth","type":"http","scheme":"bearer"}],"scopes":[]}],"responseCodes":["200","401","405","429","default"],"pointer":"/v1/jobs/{id}","href":"jobs/jobs_get","openApiOperationId":"jobs_get","summary":"Get job"},"isWebhook":false,"hideReplay":false,"servers":[{"url":"/_mock/engage/openapi","description":"Mock server","isMockServer":true},{"url":"https://engage.shuffll.com/api"}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"header","level":4,"label":"Responses","labelTranslationKey":"responses","deepLinkSuffix":"responses"},{"nodeType":"item-content","variant":"responses","responses":[{"code":"200","description":"Current resource or page.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}},"schemaId":"schema_66","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"},{"code":"401","description":"Missing or invalid Bearer authentication.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"WWW-Authenticate":{"required":true,"schema":{"type":"string","enum":["Bearer"]}}},"headerSchemaId":"schema_6"},{"code":"405","description":"Method not allowed for this path.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Allow":{"required":true,"description":"Comma-separated methods allowed for this path.","schema":{"type":"string"}}},"headerSchemaId":"schema_7"},{"code":"429","description":"Rate limited; wait before retrying.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}},"Retry-After":{"required":true,"description":"Seconds to wait before polling or retrying.","schema":{"type":"integer","minimum":0}}},"headerSchemaId":"schema_8"},{"code":"default","description":"Error. The JSON body contains error.code and error.requestId.","mediaType":"application/json","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}},"schemaId":"schema_5","headers":{"X-Request-Id":{"required":true,"description":"Identifier for tracing this response.","schema":{"type":"string","format":"uuid"}}},"headerSchemaId":"schema_9"}],"pointer":"/paths/~1v1~1jobs~1{id}/get/responses"}],"panels":[{"children":[{"kind":"response","responseCodes":[{"code":"200","schemaId":"schema_66","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_66"}}},{"code":"401","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"405","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"429","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}},{"code":"default","schemaId":"schema_5","mediaTypes":["application/json"],"mediaTypeContent":{"application/json":{"schemaId":"schema_5"}}}],"examples":[]}]}]},{"nodeType":"container","children":[{"nodeType":"feedback","pageSlug":"/jobs/jobs_get"}],"panels":[]}]},"httpPath":"/v1/jobs/{id}"}],"content":{"contentType":"group","meta":{"name":"Jobs"},"children":[{"nodeType":"container","children":[{"nodeType":"header","level":2,"label":"Jobs","showPageActions":true},{"nodeType":"markdoc","content":"Inspect asynchronous operation status and results."}],"panels":[{"children":[{"kind":"group-items","title":"Operations","titleTranslationKey":"operations","items":[{"title":"/v1/jobs/{id}","summary":"Get job","prefix":{"name":"get","color":"get"},"badges":[],"link":"/jobs/jobs_get","deprecated":false}]}]}]}]}}],"store":{"schemaStore":{"schema_0":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":200},"id":"schema_0"},"schema_1":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"slug":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"},"owner_email":{"type":"string","maxLength":254,"format":"email","pattern":"^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"},"owner_name":{"type":"string","minLength":1,"maxLength":160},"timezone":{"type":"string","maxLength":100},"brand_mode":{"type":"string","enum":["single","hub"]},"custom_domain":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]}},"required":["name","slug","owner_email","timezone","brand_mode"],"additionalProperties":false},"id":"schema_1"},"schema_2":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"command":{"type":"string"},"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"state":{"type":"string","enum":["queued","running","waiting_for_approval","succeeded","partially_failed","failed","cancelling","cancelled","recovery_required"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"result":{"anyOf":[{"type":"object","properties":{"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"insertedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deletedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":99},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"status":{"type":"string","enum":["inserted","updated","unchanged","deleted","invalid_request","duplicate_external_id","recipient_locked","resource_not_found"]}},"required":["index","status"],"additionalProperties":false}},"succeeded":{"type":"number"},"failed":{"type":"number"},"secretAvailable":{"type":"boolean","const":false}},"additionalProperties":false},{"type":"null"}]},"pollAfterSeconds":{"type":"number"}},"required":["id","command","resourceId","state","createdAt","updatedAt","result","pollAfterSeconds"],"additionalProperties":false},"secretAvailable":{"default":false,"type":"boolean"},"secret":{"type":"string"},"key":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"level":{"type":"string","enum":["platform","meta_org","organization"]},"meta_organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"environment":{"type":"string","const":"dev"},"display_prefix":{"type":"string"},"created_by":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"issuer_key_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"delegation_allowed":{"type":"boolean"},"created_at":{"type":"string"},"expires_at":{"type":"string"},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","level","meta_organization_id","organization_id","name","scopes","environment","display_prefix","created_by","issuer_key_id","delegation_allowed","created_at","expires_at","revoked_at","last_used_at"],"additionalProperties":false}},"required":["job","secretAvailable"],"additionalProperties":false},"id":"schema_2"},"schema_3":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"Location":{"type":"string","format":"uri","description":"Absolute URL of the operation job, from the trusted server origin."},"ETag":{"type":"string","description":"Quoted opaque revision when the resource or job result has one."}},"required":["X-Request-Id","Location"]},"id":"schema_3"},"schema_4":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"Location":{"type":"string","format":"uri","description":"Absolute URL of the operation job, from the trusted server origin."},"Retry-After":{"type":"integer","minimum":0,"description":"Seconds to wait before polling or retrying."},"ETag":{"type":"string","description":"Quoted opaque revision when the resource or job result has one."}},"required":["X-Request-Id","Location","Retry-After"]},"id":"schema_4"},"schema_5":{"kind":"json-schema","data":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","requestId"],"properties":{"code":{"type":"string","enum":["activation_prerequisites_missing","asset_storage_unavailable","batch_limit_exceeded","catalog_unavailable","idempotency_conflict","insufficient_scope","invalid_asset","invalid_request","method_not_allowed","not_found","operation_conflict","operation_failed","origin_forbidden","payload_too_large","precondition_failed","precondition_required","rate_limited","render_source_unavailable","tenant_disabled","transaction_retry_required","unauthorized","unsupported_media_type","upload_expired","upload_incomplete","upload_revoked"]},"requestId":{"type":"string"}}}}},"id":"schema_5"},"schema_6":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"WWW-Authenticate":{"type":"string","enum":["Bearer"]}},"required":["X-Request-Id","WWW-Authenticate"]},"id":"schema_6"},"schema_7":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"Allow":{"type":"string","description":"Comma-separated methods allowed for this path."}},"required":["X-Request-Id","Allow"]},"id":"schema_7"},"schema_8":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"Retry-After":{"type":"integer","minimum":0,"description":"Seconds to wait before polling or retrying."}},"required":["X-Request-Id","Retry-After"]},"id":"schema_8"},"schema_9":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."}},"required":["X-Request-Id"]},"id":"schema_9"},"schema_10":{"kind":"json-schema","data":{"default":50,"type":"integer","minimum":1,"maximum":100},"id":"schema_10"},"schema_11":{"kind":"json-schema","data":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"id":"schema_11"},"schema_12":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"slug":{"type":"string"},"is_active":{"type":"boolean"},"custom_domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"brand_mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"provisioning":{"type":"string","enum":["ready","provisioning","recovery_required","unmanaged"]},"activation":{"type":"object","properties":{"ready":{"type":"boolean"},"missing":{"type":"array","items":{"type":"string"}}},"required":["ready","missing"],"additionalProperties":false}},"required":["id","name","slug","is_active","custom_domain","timezone","brand_mode","revision","provisioning","activation"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_12"},"schema_13":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"slug":{"type":"string"},"is_active":{"type":"boolean"},"custom_domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"timezone":{"anyOf":[{"type":"string"},{"type":"null"}]},"brand_mode":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"provisioning":{"type":"string","enum":["ready","provisioning","recovery_required","unmanaged"]},"activation":{"type":"object","properties":{"ready":{"type":"boolean"},"missing":{"type":"array","items":{"type":"string"}}},"required":["ready","missing"],"additionalProperties":false}},"required":["id","name","slug","is_active","custom_domain","timezone","brand_mode","revision","provisioning","activation"],"additionalProperties":false},"id":"schema_13"},"schema_14":{"kind":"json-schema","data":{"type":"object","properties":{"X-Request-Id":{"type":"string","format":"uuid","description":"Identifier for tracing this response."},"ETag":{"type":"string","description":"Quoted opaque revision when the resource or job result has one."}},"required":["X-Request-Id"]},"id":"schema_14"},"schema_15":{"kind":"json-schema","data":{"type":"string"},"id":"schema_15"},"schema_16":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"custom_domain":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]},"timezone":{"type":"string","maxLength":100}},"required":[],"additionalProperties":false},"id":"schema_16"},"schema_17":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"is_active":{"type":"boolean"}},"required":["is_active"],"additionalProperties":false},"id":"schema_17"},"schema_18":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"slug":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"}},"required":["name","slug"],"additionalProperties":false},"id":"schema_18"},"schema_19":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"slug":{"type":"string"},"is_active":{"type":"boolean"},"is_default":{"type":"boolean"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"favicon_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"accent_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"font_family":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","meta_organization_id","name","slug","is_active","is_default","revision","logo_url","favicon_url","primary_color","secondary_color","accent_color","font_family"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_19"},"schema_20":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"slug":{"type":"string"},"is_active":{"type":"boolean"},"is_default":{"type":"boolean"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"favicon_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"accent_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"font_family":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","meta_organization_id","name","slug","is_active","is_default","revision","logo_url","favicon_url","primary_color","secondary_color","accent_color","font_family"],"additionalProperties":false},"id":"schema_20"},"schema_21":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160},"slug":{"type":"string","pattern":"^[a-z0-9][a-z0-9-]{0,79}$"}},"required":[],"additionalProperties":false},"id":"schema_21"},"schema_22":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{},"required":[],"additionalProperties":false},"id":"schema_22"},"schema_23":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"logo_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"favicon_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"primary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"secondary_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"accent_color":{"anyOf":[{"type":"string"},{"type":"null"}]},"font_family":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","revision","logo_url","favicon_url","primary_color","secondary_color","accent_color","font_family"],"additionalProperties":false},"id":"schema_23"},"schema_24":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"logo_asset_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"favicon_asset_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"primary_color":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"secondary_color":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"accent_color":{"anyOf":[{"type":"string","pattern":"^#[0-9a-fA-F]{6}$"},{"type":"null"}]},"font_family":{"anyOf":[{"type":"string","minLength":1,"maxLength":120,"pattern":"^[\\p{L}\\p{N} ,'-]+$"},{"type":"null"}]}},"required":[],"additionalProperties":false},"id":"schema_24"},"schema_25":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"user_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"role":{"type":"string","enum":["org_admin","user"]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","user_id","organization_id","role","revision"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_25"},"schema_26":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"email":{"type":"string"},"role":{"type":"string","enum":["org_admin","user"]}},"required":["email","role"],"additionalProperties":false},"id":"schema_26"},"schema_27":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"role":{"type":"string","enum":["org_admin","user"]}},"required":["role"],"additionalProperties":false},"id":"schema_27"},"schema_28":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"email":{"type":"string"},"role":{"type":"string","enum":["org_admin","user"]},"status":{"type":"string","enum":["pending","accepted","revoked"]},"delivery":{"type":"string","enum":["queued","sending","sent","failed","recovery_required"]},"expires_at":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","organization_id","email","role","status","delivery","expires_at","revision"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_28"},"schema_29":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"email":{"type":"string"},"role":{"type":"string","enum":["org_admin","user"]},"status":{"type":"string","enum":["pending","accepted","revoked"]},"delivery":{"type":"string","enum":["queued","sending","sent","failed","recovery_required"]},"expires_at":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","organization_id","email","role","status","delivery","expires_at","revision"],"additionalProperties":false},"id":"schema_29"},"schema_30":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"media_type":{"type":"string","enum":["image/png","image/jpeg","image/webp"]},"size":{"type":"integer","minimum":1,"maximum":10485760}},"required":["media_type","size"],"additionalProperties":false},"id":"schema_30"},"schema_31":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"job":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"command":{"type":"string"},"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"state":{"type":"string","enum":["queued","running","waiting_for_approval","succeeded","partially_failed","failed","cancelling","cancelled","recovery_required"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"result":{"anyOf":[{"type":"object","properties":{"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"insertedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deletedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":99},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"status":{"type":"string","enum":["inserted","updated","unchanged","deleted","invalid_request","duplicate_external_id","recipient_locked","resource_not_found"]}},"required":["index","status"],"additionalProperties":false}},"succeeded":{"type":"number"},"failed":{"type":"number"},"secretAvailable":{"type":"boolean","const":false}},"additionalProperties":false},{"type":"null"}]},"pollAfterSeconds":{"type":"number"}},"required":["id","command","resourceId","state","createdAt","updatedAt","result","pollAfterSeconds"],"additionalProperties":false},"upload":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"status":{"type":"string","enum":["pending","ready","revoked","expired"]},"media_type":{"type":"string","enum":["image/png","image/jpeg","image/webp"]},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"finalize_before":{"type":"string"},"upload_capability_validity_seconds":{"type":"number","const":7200},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","status","media_type","size","finalize_before","upload_capability_validity_seconds","revision"],"additionalProperties":false},"capability":{"anyOf":[{"type":"object","properties":{"url":{"type":"string","format":"uri"},"method":{"type":"string","const":"PUT"},"content_type":{"type":"string"},"issued_at":{"type":"string"},"validity_seconds":{"type":"number","const":7200}},"required":["url","method","content_type","issued_at","validity_seconds"],"additionalProperties":false},{"type":"null"}]}},"required":["job","upload","capability"],"additionalProperties":false},"id":"schema_31"},"schema_32":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"status":{"type":"string","enum":["pending","ready","revoked","expired"]},"media_type":{"type":"string","enum":["image/png","image/jpeg","image/webp"]},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"finalize_before":{"type":"string"},"upload_capability_validity_seconds":{"type":"number","const":7200},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","status","media_type","size","finalize_before","upload_capability_validity_seconds","revision"],"additionalProperties":false},"id":"schema_32"},"schema_33":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"status":{"type":"string","enum":["pending","ready","rejected"]},"media_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"public_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","meta_organization_id","organization_id","status","media_type","size","public_url","verified_at","revision"],"additionalProperties":false},"id":"schema_33"},"schema_34":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"status":{"type":"string","enum":["pending","ready","rejected"]},"media_type":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"public_url":{"anyOf":[{"type":"string"},{"type":"null"}]},"verified_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","meta_organization_id","organization_id","status","media_type","size","public_url","verified_at","revision"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_34"},"schema_35":{"kind":"json-schema","data":{"type":"string","minLength":1,"maxLength":256},"id":"schema_35"},"schema_36":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","minLength":1,"maxLength":256},"name":{"type":"string"},"native_name":{"type":"string"},"provider":{"type":"string"},"family":{"type":"string"},"kind":{"type":"string","enum":["image","video"]}},"required":["id","name"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","minLength":1,"maxLength":256},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_36"},"schema_37":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"category":{"type":"string"},"lang":{"type":"string"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"last_published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"render_source_status":{"type":"string","enum":["unavailable","ready"]},"render_source_format":{"anyOf":[{"type":"string","const":"flat-video-v1"},{"type":"null"}]},"render_source_reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","category","lang","meta_organization_id","organization_id","last_published_at","render_source_status"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_37"},"schema_38":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"category":{"type":"string"},"lang":{"type":"string"},"meta_organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"last_published_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"render_source_status":{"type":"string","enum":["unavailable","ready"]},"render_source_format":{"anyOf":[{"type":"string","const":"flat-video-v1"},{"type":"null"}]},"render_source_reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","category","lang","meta_organization_id","organization_id","last_published_at","render_source_status"],"additionalProperties":false},"id":"schema_38"},"schema_39":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"version_number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"type":"string"},"change_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"type":"string"},"actor_kind":{"type":"string","enum":["user","api_key","unknown"]},"render_source_status":{"type":"string","enum":["unavailable","ready"]},"render_source_format":{"anyOf":[{"type":"string","const":"flat-video-v1"},{"type":"null"}]},"render_source_reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","template_id","version_number","name","change_note","published_at","actor_kind","render_source_status"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_39"},"schema_40":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"version_number":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"name":{"type":"string"},"change_note":{"anyOf":[{"type":"string"},{"type":"null"}]},"published_at":{"type":"string"},"actor_kind":{"type":"string","enum":["user","api_key","unknown"]},"render_source_status":{"type":"string","enum":["unavailable","ready"]},"render_source_format":{"anyOf":[{"type":"string","const":"flat-video-v1"},{"type":"null"}]},"render_source_reason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","template_id","version_number","name","change_note","published_at","actor_kind","render_source_status"],"additionalProperties":false},"id":"schema_40"},"schema_41":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_version_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string","minLength":1,"maxLength":160}},"required":["organization_id","template_id","template_version_id","name"],"additionalProperties":false},"id":"schema_41"},"schema_42":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_version_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"production_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign_to_send":{"type":"boolean","const":false},"auto_export_recipients":{"type":"boolean","const":false},"workspace_status":{"type":"string","enum":["pending","dispatching","ready","recovery_required"]},"format":{"type":"string","const":"flat-video-v1"},"personalization":{"type":"boolean","const":false},"created_at":{"type":"string"}},"required":["id","organization_id","template_id","template_version_id","production_id","name","revision","archived_at","campaign_to_send","auto_export_recipients","workspace_status","format","personalization","created_at"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_42"},"schema_43":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":160}},"required":["name"],"additionalProperties":false},"id":"schema_43"},"schema_44":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"organization_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"template_version_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"production_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"name":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"archived_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaign_to_send":{"type":"boolean","const":false},"auto_export_recipients":{"type":"boolean","const":false},"workspace_status":{"type":"string","enum":["pending","dispatching","ready","recovery_required"]},"format":{"type":"string","const":"flat-video-v1"},"personalization":{"type":"boolean","const":false},"created_at":{"type":"string"}},"required":["id","organization_id","template_id","template_version_id","production_id","name","revision","archived_at","campaign_to_send","auto_export_recipients","workspace_status","format","personalization","created_at"],"additionalProperties":false},"id":"schema_44"},"schema_45":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"valid":{"type":"boolean","const":true},"format":{"type":"string","const":"flat-video-v1"},"personalization":{"type":"boolean","const":false},"generation_available":{"type":"boolean"},"workspace_status":{"type":"string","enum":["pending","dispatching","ready","recovery_required"]}},"required":["id","valid","format","personalization","generation_available","workspace_status"],"additionalProperties":false},"id":"schema_45"},"schema_46":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"scenes":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"trim_start_ms":{"type":"integer","minimum":0,"maximum":9007199254740991},"trim_end_ms":{"type":"integer","exclusiveMinimum":0,"maximum":60000},"muted":{"type":"boolean"}},"required":["id","trim_start_ms","trim_end_ms","muted"],"additionalProperties":false}}},"required":["scenes"],"additionalProperties":false},"id":"schema_46"},"schema_47":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"format":{"type":"string","const":"flat-video-v1"},"personalization":{"type":"boolean","const":false},"scenes":{"minItems":1,"maxItems":5,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"trim_start_ms":{"type":"integer","minimum":0,"maximum":9007199254740991},"trim_end_ms":{"type":"integer","exclusiveMinimum":0,"maximum":60000},"muted":{"type":"boolean"},"duration_ms":{"type":"number","exclusiveMinimum":0}},"required":["id","trim_start_ms","trim_end_ms","muted","duration_ms"],"additionalProperties":false}},"capabilities":{"type":"object","properties":{"trim":{"type":"boolean","const":true},"mute":{"type":"boolean","const":true},"personalization":{"type":"boolean","const":false},"branding_in_video":{"type":"boolean","const":false},"transitions":{"type":"array","items":{"not":{}}}},"required":["trim","mute","personalization","branding_in_video","transitions"],"additionalProperties":false}},"required":["id","campaign_id","revision","format","personalization","scenes","capabilities"],"additionalProperties":false},"id":"schema_47"},"schema_48":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"items":{"description":[{"$$mdtype":"Node","attributes":{},"children":[{"$$mdtype":"Node","inline":true,"attributes":{"content":"Each record: required external_id (1–200 characters, no surrounding whitespace); optional nullable name, first_name, last_name (up to 200 characters), phone (E.164). Unknown fields reject that item. No personalization or delivery fields."},"children":[],"type":"text"}],"type":"paragraph"}],"minItems":1,"maxItems":100,"type":"array","items":{}}},"required":["items"],"additionalProperties":false},"id":"schema_48"},"schema_49":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"external_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"locked":{"type":"boolean"},"created_at":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","campaign_id","external_id","name","first_name","last_name","phone","locked","created_at","revision"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lockedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["data","nextCursor","total","lockedTotal","revision"],"additionalProperties":false},"id":"schema_49"},"schema_50":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"external_id":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}]},"phone":{"anyOf":[{"type":"string"},{"type":"null"}]},"locked":{"type":"boolean"},"created_at":{"type":"string"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","campaign_id","external_id","name","first_name","last_name","phone","locked","created_at","revision"],"additionalProperties":false},"id":"schema_50"},"schema_51":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"recipient_ids":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}}},"required":["recipient_ids"],"additionalProperties":false},"id":"schema_51"},"schema_52":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"recipient_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"generation_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"state":{"type":"string","enum":["queued","running","recovery_required","succeeded","failed"]},"video_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"thumbnails":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"timestamp_seconds":{"type":"number","minimum":0},"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["url","timestamp_seconds","width","height"],"additionalProperties":false}},"duration_seconds":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}]},"error":{"anyOf":[{"type":"string","enum":["render_failed","source_unavailable","authority_revoked"]},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","campaign_id","recipient_id","generation_id","revision","state","video_url","thumbnails","duration_seconds","error","created_at"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["data","nextCursor","total"],"additionalProperties":false},"id":"schema_52"},"schema_53":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"recipient_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"generation_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"state":{"type":"string","enum":["queued","running","recovery_required","succeeded","failed"]},"video_url":{"anyOf":[{"type":"string","format":"uri"},{"type":"null"}]},"thumbnails":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"url":{"type":"string","format":"uri"},"timestamp_seconds":{"type":"number","minimum":0},"width":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991},"height":{"type":"integer","exclusiveMinimum":0,"maximum":9007199254740991}},"required":["url","timestamp_seconds","width","height"],"additionalProperties":false}},"duration_seconds":{"anyOf":[{"type":"number","exclusiveMinimum":0},{"type":"null"}]},"error":{"anyOf":[{"type":"string","enum":["render_failed","source_unavailable","authority_revoked"]},{"type":"null"}]},"created_at":{"type":"string"}},"required":["id","campaign_id","recipient_id","generation_id","revision","state","video_url","thumbnails","duration_seconds","error","created_at"],"additionalProperties":false},"id":"schema_53"},"schema_54":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"campaign_id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"recipients":{"type":"integer","minimum":0,"maximum":9007199254740991},"attempts":{"type":"integer","minimum":0,"maximum":9007199254740991},"queued":{"type":"integer","minimum":0,"maximum":9007199254740991},"running":{"type":"integer","minimum":0,"maximum":9007199254740991},"recovery_required":{"type":"integer","minimum":0,"maximum":9007199254740991},"succeeded":{"type":"integer","minimum":0,"maximum":9007199254740991},"failed":{"type":"integer","minimum":0,"maximum":9007199254740991}},"required":["campaign_id","recipients","attempts","queued","running","recovery_required","succeeded","failed"],"additionalProperties":false},"id":"schema_54"},"schema_55":{"kind":"json-schema","data":{"type":"string","enum":["platform","meta_org","organization"]},"id":"schema_55"},"schema_56":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"level":{"type":"string","enum":["platform","meta_org","organization"]},"meta_organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"environment":{"type":"string","const":"dev"},"display_prefix":{"type":"string"},"created_by":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"issuer_key_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"delegation_allowed":{"type":"boolean"},"created_at":{"type":"string"},"expires_at":{"type":"string"},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","level","meta_organization_id","organization_id","name","scopes","environment","display_prefix","created_by","issuer_key_id","delegation_allowed","created_at","expires_at","revoked_at","last_used_at"],"additionalProperties":false}},"nextCursor":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]}},"required":["data","nextCursor"],"additionalProperties":false},"id":"schema_56"},"schema_57":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"level":{"type":"string","enum":["platform","meta_org","organization"]},"metaOrganizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"name":{"type":"string","minLength":1,"maxLength":120},"scopes":{"minItems":1,"maxItems":100,"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"lifetimeSeconds":{"type":"integer","minimum":1,"maximum":7776000},"delegationAllowed":{"default":false,"type":"boolean"}},"required":["level","metaOrganizationId","organizationId","name","scopes"],"additionalProperties":false},"id":"schema_57"},"schema_58":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"level":{"type":"string","enum":["platform","meta_org","organization"]},"meta_organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organization_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"name":{"type":"string"},"scopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"environment":{"type":"string","const":"dev"},"display_prefix":{"type":"string"},"created_by":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"issuer_key_id":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"delegation_allowed":{"type":"boolean"},"created_at":{"type":"string"},"expires_at":{"type":"string"},"revoked_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"last_used_at":{"anyOf":[{"type":"string"},{"type":"null"}]},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["id","level","meta_organization_id","organization_id","name","scopes","environment","display_prefix","created_by","issuer_key_id","delegation_allowed","created_at","expires_at","revoked_at","last_used_at"],"additionalProperties":false},"id":"schema_58"},"schema_59":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"overlapSeconds":{"default":0,"type":"integer","minimum":0,"maximum":86400},"lifetimeSeconds":{"type":"integer","minimum":1,"maximum":7776000}},"required":[],"additionalProperties":false},"id":"schema_59"},"schema_60":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"enabled":{"type":"boolean"},"scopes":{"maxItems":100,"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"delegationAllowed":{"default":false,"type":"boolean"},"selfService":{"default":false,"type":"boolean"},"readPerMinute":{"type":"integer","minimum":1,"maximum":100000},"mutationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"generationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"activeGenerations":{"type":"integer","minimum":1,"maximum":10000},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"}},"required":["enabled","scopes","delegationAllowed","selfService","id","revision"],"additionalProperties":false},"id":"schema_60"},"schema_61":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"enabled":{"type":"boolean"},"scopes":{"maxItems":100,"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"delegationAllowed":{"default":false,"type":"boolean"},"selfService":{"default":false,"type":"boolean"},"readPerMinute":{"type":"integer","minimum":1,"maximum":100000},"mutationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"generationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"activeGenerations":{"type":"integer","minimum":1,"maximum":10000}},"required":["enabled","scopes"],"additionalProperties":false},"id":"schema_61"},"schema_62":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"level":{"type":"string","enum":["platform","meta_org","organization"]},"metaOrganizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"enabled":{"type":"boolean"},"scopes":{"maxItems":100,"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"delegationAllowed":{"default":false,"type":"boolean"},"selfService":{"default":false,"type":"boolean"},"readPerMinute":{"type":"integer","minimum":1,"maximum":100000},"mutationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"generationPerMinute":{"type":"integer","minimum":1,"maximum":100000},"activeGenerations":{"type":"integer","minimum":1,"maximum":10000}},"required":["level","metaOrganizationId","organizationId","enabled","scopes"],"additionalProperties":false},"id":"schema_62"},"schema_63":{"kind":"json-schema","data":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"id":"schema_63"},"schema_64":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"level":{"type":"string","enum":["platform","meta_org","organization"]},"metaOrganizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"exists":{"type":"boolean"},"enabled":{"type":"boolean"},"targetActive":{"type":"boolean"},"ancestorsEnabled":{"type":"boolean"},"scopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"ceilingScopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"delegationAllowed":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"selfService":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"readPerMinute":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"mutationPerMinute":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"generationPerMinute":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"activeGenerations":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["level","metaOrganizationId","organizationId","exists","enabled","targetActive","ancestorsEnabled","scopes","ceilingScopes","delegationAllowed","selfService","readPerMinute","mutationPerMinute","generationPerMinute","activeGenerations"],"additionalProperties":false},"id":"schema_64"},"schema_65":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"level":{"type":"string","enum":["platform","meta_org","organization"]},"metaOrganizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"organizationId":{"anyOf":[{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},{"type":"null"}]},"scopes":{"type":"array","items":{"type":"string","enum":["meta-organizations:provision","meta-organizations:read","meta-organizations:write","api-access:manage","organizations:read","organizations:write","brands:read","brands:write","members:read","members:write","assets:read","assets:write","templates:read","templates:write","templates:use_shared","templates:generate","templates:publish","campaigns:read","campaigns:write","campaigns:generate","campaigns:send","recipients:read","recipients:write","results:read","analytics:read","jobs:read","jobs:write","webhooks:read","webhooks:write","keys:manage","connections:read","connections:manage","connections:sync","products:read","products:write"]}},"operations":{"type":"array","items":{"type":"string"}},"transitions":{"type":"array","items":{"not":{}}},"apiEnabled":{"type":"boolean"},"uploads":{"type":"object","properties":{"media_types":{"type":"array","items":{"type":"string"}},"max_bytes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"finalize_within_seconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"upload_capability_validity_seconds":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["media_types","max_bytes","finalize_within_seconds","upload_capability_validity_seconds"],"additionalProperties":false}},"required":["level","metaOrganizationId","organizationId","scopes","operations","transitions","apiEnabled","uploads"],"additionalProperties":false},"id":"schema_65"},"schema_66":{"kind":"json-schema","data":{"$schema":"http://json-schema.org/draft-07/schema#","type":"object","properties":{"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"command":{"type":"string"},"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"state":{"type":"string","enum":["queued","running","waiting_for_approval","succeeded","partially_failed","failed","cancelling","cancelled","recovery_required"]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"result":{"anyOf":[{"type":"object","properties":{"resourceId":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"revision":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"insertedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"updatedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deletedTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"items":{"maxItems":100,"type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":99},"id":{"type":"string","pattern":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"status":{"type":"string","enum":["inserted","updated","unchanged","deleted","invalid_request","duplicate_external_id","recipient_locked","resource_not_found"]}},"required":["index","status"],"additionalProperties":false}},"succeeded":{"type":"number"},"failed":{"type":"number"},"secretAvailable":{"type":"boolean","const":false}},"additionalProperties":false},{"type":"null"}]},"pollAfterSeconds":{"type":"number"}},"required":["id","command","resourceId","state","createdAt","updatedAt","result","pollAfterSeconds"],"additionalProperties":false},"id":"schema_66"}},"exampleStore":{},"securitySchemeStore":{"bearerAuth":{"id":"bearerAuth","type":"http","scheme":"bearer"}},"specVersion":"3.1.0","servers":[{"url":"/_mock/engage/openapi","isMockServer":true,"description":"Mock server"},{"url":"https://engage.shuffll.com/api"}],"specType":"openapi"},"options":{"mockServer":{"url":"/_mock/engage/openapi","position":"first","description":"Mock server"},"disableRouter":true,"downloadUrls":[{"url":"/_bundle/engage/openapi.json?download"},{"url":"/_bundle/engage/openapi.yaml?download"}],"excludeFromSearch":false,"replayFeatures":{"graphql":false,"asyncapi":false},"specType":"openapi","markdocOptions":{"tags":{},"nodes":{},"components":{}},"metadata":{"title":"Engage API","description":"V1 operation reference for Shuffll Engage. The flat-video-v1 campaign rendering format uses fixed clips; that format-specific restriction does not describe the full Engage product. Discover live workspace capabilities and the MCP tool catalog for available workflows. Access is checked against tenant policy and principal authority."}},"baseSlug":"/engage/openapi","routesMapping":{}}