{"openapi":"3.1.0","info":{"title":"Customer.io Design Studio (BYOK) API","version":"0.1.0","description":"Customer.io Design Studio (BYOK) lets an AI assistant read your own Customer.io Design Studio data through the Customer.io Design Studio API with a key you supply (App API key (US region)). Read-only: 6 tools (list_design_folders, list_design_emails, list_design_sms, list_design_components, check_unpublished_changes, get_inbox_preview_credits). The BYOK key travels with each request, is used for...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-customerio-design-studio.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-customerio-design-studio/docs"},"termsOfService":"https://connectorbay.com/byok-customerio-design-studio/terms"},"servers":[{"url":"https://byok-customerio-design-studio.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-customerio-design-studio/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_design_folders":{"post":{"operationId":"list_design_folders","summary":"List Design Studio folders with id, name, parent folder and dates. Use for \"Which folders organize my Customer.io design","description":"List Design Studio folders with id, name, parent folder and dates. Use for \"Which folders organize my Customer.io designs\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"parent_folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items inside this folder id.","title":"Parent Folder Id"},"direct_descendants_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only direct children of the folder (default false lists all descendants).","title":"Direct Descendants Only"},"sort_by":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by created, updated or name.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order: asc or desc.","title":"Sort Order"}},"title":"list_design_foldersArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_design_emails":{"post":{"operationId":"list_design_emails","summary":"List Design Studio emails with id, name, folder, template flag, translation flag, whether linked to a workflow, and date","description":"List Design Studio emails with id, name, folder, template flag, translation flag, whether linked to a workflow, and dates. Email content is not returned. Use for \"Which email designs exist in Customer.io Design Studio\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"parent_folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items inside this folder id.","title":"Parent Folder Id"},"direct_descendants_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only direct children of the folder (default false lists all descendants).","title":"Direct Descendants Only"},"sort_by":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by created, updated or name.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order: asc or desc.","title":"Sort Order"},"is_template":{"anyOf":[{"enum":["true","false","any"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by template flag: true, false or any.","title":"Is Template"},"is_linked":{"anyOf":[{"enum":["true","false","any"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by whether the email is used in a workflow: true, false or any.","title":"Is Linked"},"has_translations":{"anyOf":[{"enum":["true","false","any"],"type":"string"},{"type":"null"}],"default":null,"description":"Filter by whether the email has translations: true, false or any.","title":"Has Translations"}},"title":"list_design_emailsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_design_sms":{"post":{"operationId":"list_design_sms","summary":"List Design Studio SMS designs with id, name, folder, whether linked to a workflow and dates. Message text is not return","description":"List Design Studio SMS designs with id, name, folder, whether linked to a workflow and dates. Message text is not returned. Use for \"Which SMS designs exist in Customer.io Design Studio\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"parent_folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items inside this folder id.","title":"Parent Folder Id"},"direct_descendants_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only direct children of the folder (default false lists all descendants).","title":"Direct Descendants Only"},"sort_by":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by created, updated or name.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order: asc or desc.","title":"Sort Order"}},"title":"list_design_smsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/list_design_components":{"post":{"operationId":"list_design_components","summary":"List reusable email components with id, name, tag name, folder and dates. Use for \"Which reusable email components exist","description":"List reusable email components with id, name, tag name, folder and dates. Use for \"Which reusable email components exist in Customer.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"limit":{"anyOf":[{"maximum":1000,"minimum":1,"type":"integer"},{"type":"null"}],"default":100,"description":"How many results to return (1 to 1000).","title":"Limit"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"},"parent_folder_id":{"anyOf":[{"maxLength":80,"type":"string"},{"type":"null"}],"default":null,"description":"Only items inside this folder id.","title":"Parent Folder Id"},"direct_descendants_only":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":false,"description":"True to list only direct children of the folder (default false lists all descendants).","title":"Direct Descendants Only"},"sort_by":{"anyOf":[{"enum":["created","updated","name"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort by created, updated or name.","title":"Sort By"},"sort_order":{"anyOf":[{"enum":["asc","desc"],"type":"string"},{"type":"null"}],"default":null,"description":"Sort order: asc or desc.","title":"Sort Order"},"tag":{"anyOf":[{"maxLength":100,"type":"string"},{"type":"null"}],"default":null,"description":"Only components with this tag name.","title":"Tag"}},"title":"list_design_componentsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/check_unpublished_changes":{"post":{"operationId":"check_unpublished_changes","summary":"Check whether a Design Studio email has unpublished changes. Use for \"Does Customer.io email design e1 have unpublished ","description":"Check whether a Design Studio email has unpublished changes. Use for \"Does Customer.io email design e1 have unpublished changes\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"The Design Studio email id (for a multi-language email use the default language id).","maxLength":80,"title":"Id","type":"string"}},"required":["id"],"title":"check_unpublished_changesArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_inbox_preview_credits":{"post":{"operationId":"get_inbox_preview_credits","summary":"Show the inbox preview credit balance: original and remaining credits, tier (free or paid) and expiry. Use for \"How many","description":"Show the inbox preview credit balance: original and remaining credits, tier (free or paid) and expiry. Use for \"How many inbox preview credits do I have left in Customer.io\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{},"title":"get_inbox_preview_creditsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}