{"openapi":"3.1.0","info":{"title":"Simplero API","version":"v2","description":"## Authentication\n\nAuthenticate via **HTTP Basic Auth** (API key as username, password left blank) or the **X-API-Key** header.\n\nGet your API key from the Simplero admin under Settings \u003e Integrations.\n\n## User-Agent\n\nInclude your app name and contact email in the User-Agent header: `MyApp (me@example.com)`.\n\n## Pagination\n\nList endpoints accept `page` and `per_page` (1–100, default 20).\n"},"servers":[{"url":"https://simplero.com"}],"security":[{"apiKeyHeader":[]}],"tags":[{"name":"Actions","description":"The exact shape of `args` depends on the value of `action`. Before creating or updating an Action,\nuse `GET actions/available` to list the action ids available for a given target type (e.g. `Customer`, `Ticket`),\nthen `GET actions/detail` with that id to get the typed `args` schema.\n"},{"name":"Landing Pages","description":"To create or modify the content of a landing page, first create the record,\nthen use the various builder endpoints below to manage its content tree (only when its a builder doc page).\n\nThere's 2 ways to create/manage builder content\n 1. HTML sections (preferred)\n      * 3 endpoints: html_section show, html_section update (create/update), html_section embed.\n      * Anything HTML goes. Very flexible.\n      * You can still chose to embed structured nodes inside it using the embed endpoint to get html embed code for a structured node.\n      * See the description of the html_section update endpoint (POST builder/content/html_section) for detailed info on how this works (when it creates vs updates, how to use the embed endpoint, etc.).\n 2. Structured\n      * A hierarchical builder where you add sections \u003e rows \u003e columns \u003e elements.\n      * Has endpoints to list available nodes, including filtering available node children for a given node id.\n      * You add things hierarchically one by one (i.e add section with settings, then add a row with parent id set to the section's returned node id).\n\nIf you want fancy pages, prefer using the HTML section endpoint + embedding structured nodes inside it (like embedding order form or input fields/buttons/etc.)\n\n\nTo create or modify the content of a landing page, first create the record,\nthen use the various builder endpoints below to manage its content tree (only when its a builder doc page).\n\nThere's 2 ways to create/manage builder content\n 1. HTML sections (preferred)\n      * 3 endpoints: html_section show, html_section update (create/update), html_section embed.\n      * Anything HTML goes. Very flexible.\n      * You can still chose to embed structured nodes inside it using the embed endpoint to get html embed code for a structured node.\n      * See the description of the html_section update endpoint (POST builder/content/html_section) for detailed info on how this works (when it creates vs updates, how to use the embed endpoint, etc.).\n 2. Structured\n      * A hierarchical builder where you add sections \u003e rows \u003e columns \u003e elements.\n      * Has endpoints to list available nodes, including filtering available node children for a given node id.\n      * You add things hierarchically one by one (i.e add section with settings, then add a row with parent id set to the section's returned node id).\n\nIf you want fancy pages, prefer using the HTML section endpoint + embedding structured nodes inside it (like embedding order form or input fields/buttons/etc.)\n"},{"name":"Library Mailings","description":"Emails that can be used by automations and triggers."},{"name":"Pages","description":"To create or modify the content of a page, first create the record,\nthen use the various builder endpoints below to manage its content tree (only when its a builder doc page).\n\nThere's 2 ways to create/manage builder content\n 1. HTML sections (preferred)\n      * 3 endpoints: html_section show, html_section update (create/update), html_section embed.\n      * Anything HTML goes. Very flexible.\n      * You can still chose to embed structured nodes inside it using the embed endpoint to get html embed code for a structured node.\n      * See the description of the html_section update endpoint (POST builder/content/html_section) for detailed info on how this works (when it creates vs updates, how to use the embed endpoint, etc.).\n 2. Structured\n      * A hierarchical builder where you add sections \u003e rows \u003e columns \u003e elements.\n      * Has endpoints to list available nodes, including filtering available node children for a given node id.\n      * You add things hierarchically one by one (i.e add section with settings, then add a row with parent id set to the section's returned node id).\n\nIf you want fancy pages, prefer using the HTML section endpoint + embedding structured nodes inside it (like embedding order form or input fields/buttons/etc.)\n\n\nTo create or modify the content of a page, first create the record,\nthen use the various builder endpoints below to manage its content tree (only when its a builder doc page).\n\nThere's 2 ways to create/manage builder content\n 1. HTML sections (preferred)\n      * 3 endpoints: html_section show, html_section update (create/update), html_section embed.\n      * Anything HTML goes. Very flexible.\n      * You can still chose to embed structured nodes inside it using the embed endpoint to get html embed code for a structured node.\n      * See the description of the html_section update endpoint (POST builder/content/html_section) for detailed info on how this works (when it creates vs updates, how to use the embed endpoint, etc.).\n 2. Structured\n      * A hierarchical builder where you add sections \u003e rows \u003e columns \u003e elements.\n      * Has endpoints to list available nodes, including filtering available node children for a given node id.\n      * You add things hierarchically one by one (i.e add section with settings, then add a row with parent id set to the section's returned node id).\n\nIf you want fancy pages, prefer using the HTML section endpoint + embedding structured nodes inside it (like embedding order form or input fields/buttons/etc.)\n"}],"paths":{"/api/v2/actions/available":{"get":{"summary":"List available actions for a target type","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Fully qualified action id, e.g. `Customer-library_mailing`."},"title":{"type":"string","description":"Human-readable title of the action."}},"required":["id","title"]}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"description":"Returns the action ids and titles available for a given target type. Target type is the model the\naction runs on (e.g. `Customer`, `Ticket`, `Deal`). Pass `automation: true` to filter to actions\nthat can run inside automations/triggers.\n\nUse this together with `GET actions/detail` to discover the typed `args` schema for each action\nbefore creating or updating an Action.\n","parameters":[{"name":"target_type","in":"query","required":false,"schema":{"type":"string","description":"Model name the action runs on. Defaults to `Customer`."},"description":"Model name the action runs on. Defaults to `Customer`."},{"name":"automation","in":"query","required":false,"schema":{"type":"boolean","description":"When true, restrict to actions that can run inside automations/triggers."},"description":"When true, restrict to actions that can run inside automations/triggers."}]}},"/api/v2/actions/detail":{"get":{"summary":"Get the typed args schema for an action","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The action id."},"title":{"type":"string","description":"Human-readable title of the action."},"args":{"type":"object","additionalProperties":{"type":"object"},"description":"Map of arg name → JSON schema describing its type."}},"required":["id","title","args"]}}}}}},"401":{"description":"Unauthorized"}},"description":"Returns the typed `args` schema for a fully qualified action id, e.g. `Customer-library_mailing`.\nUse this to learn what to pass in the `args` field when creating or updating an Action.\n\nDuration args are surfaced as their underlying `_count` / `_unit` / `_sign` / `_seconds` sub-args,\nnot as a single `duration` type.\n","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string","description":"Fully qualified action id, e.g. `Customer-library_mailing`."},"description":"Fully qualified action id, e.g. `Customer-library_mailing`."}]}},"/api/v2/actions":{"get":{"summary":"List actions","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Action"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"}]},"post":{"summary":"Create a action","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Action"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Action"}}}}}},"/api/v2/actions/{id}":{"get":{"summary":"Get a action","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Action"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a action","tags":["Actions"],"x-simplero-resource-type":"actions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Action"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ActionOptional"}}}}}},"/api/v2/administratorships":{"get":{"summary":"List administrators","tags":["Administratorships"],"x-simplero-resource-type":"administratorships","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Administratorship"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"last_login_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"ticket_assignee","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"show_on_ticket","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"enabled","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"admin_role_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"date","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true}]}},"/api/v2/administratorships/{id}":{"get":{"summary":"Get a administrator","tags":["Administratorships"],"x-simplero-resource-type":"administratorships","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Administratorship"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/administratorships/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Administratorships"],"x-simplero-resource-type":"administratorships","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliate_programs":{"get":{"summary":"List affiliate programs","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AffiliateProgram"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}}]},"post":{"summary":"Create a affiliate program","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AffiliateProgram"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgram"}}}}}},"/api/v2/affiliate_programs/{id}":{"get":{"summary":"Get a affiliate program","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AffiliateProgram"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a affiliate program","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AffiliateProgram"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateProgramOptional"}}}}}},"/api/v2/affiliate_programs/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/affiliate_programs/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/affiliate_programs/{id}/actions/star":{"post":{"summary":"Star","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliate_programs/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Affiliate Programs"],"x-simplero-resource-type":"affiliate_programs","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates":{"get":{"summary":"List affiliates","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Affiliate"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"payout_state","in":"query","required":false,"schema":{"type":"string","enum":["payable","missing_paypal_email","missing_documentation","review_documentation","has_documentation","not_payoutable_via_paypal_masspay"]}},{"name":"affiliate_program_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"last_unit_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"last_payout_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true}]},"post":{"summary":"Create a affiliate","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Affiliate"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Affiliate"}}}}}},"/api/v2/affiliates/{id}":{"get":{"summary":"Get a affiliate","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Affiliate"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a affiliate","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Affiliate"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AffiliateOptional"}}}}}},"/api/v2/affiliates/{id}/actions/post_to_conversation":{"post":{"summary":"Post message to conversation","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"},"message":{"type":"string"}}}}}}}},"/api/v2/affiliates/{id}/actions/add_to_conversation":{"post":{"summary":"Add to conversation","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"}}}}}}}},"/api/v2/affiliates/{id}/actions/approve":{"post":{"summary":"Approve","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/reject":{"post":{"summary":"Reject","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/retire":{"post":{"summary":"Retire","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/resend_welcome":{"post":{"summary":"Resend welcome","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/approve_documentation":{"post":{"summary":"Approve documentation","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/request_documentation":{"post":{"summary":"Request documentation","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/mark_paid":{"post":{"summary":"Mark paid","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/send_login_link":{"post":{"summary":"Send login link","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/affiliates/{id}/actions/move_to_other_affiliate_program":{"post":{"summary":"Move to other affiliate program","tags":["Affiliates"],"x-simplero-resource-type":"affiliates","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"affiliate_program_id":{"type":"integer","description":"AffiliateProgram"}}}}}}}},"/api/v2/alternative_prices":{"get":{"summary":"List alternative prices","tags":["Alternative Prices"],"x-simplero-resource-type":"alternative_prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/AlternativePrice"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"priceable_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"priceable_type","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a alternative price","tags":["Alternative Prices"],"x-simplero-resource-type":"alternative_prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlternativePrice"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlternativePrice"}}}}}},"/api/v2/alternative_prices/{id}":{"get":{"summary":"Get a alternative price","tags":["Alternative Prices"],"x-simplero-resource-type":"alternative_prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlternativePrice"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a alternative price","tags":["Alternative Prices"],"x-simplero-resource-type":"alternative_prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/AlternativePrice"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlternativePriceOptional"}}}}}},"/api/v2/assets":{"post":{"summary":"Create a media file","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Asset"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"description":"Upload a file (image, video, document, etc.) via multipart form data.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file to upload (multipart)"},"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"filename":{"type":"string","readOnly":true},"content_type":{"type":"string","readOnly":true},"size":{"type":"integer","readOnly":true},"duration_seconds":{"type":"integer","readOnly":true},"width":{"type":"integer","readOnly":true},"height":{"type":"integer","readOnly":true},"media_type":{"type":"string","readOnly":true},"url":{"type":"string","readOnly":true},"transcript":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["file"]}}}}},"get":{"summary":"List media files","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Asset"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"size","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"media_type","in":"query","required":false,"schema":{"type":"string","enum":["video","audio","image","pdf","svg","javascript","css","font","other"]}},{"name":"conversion_state","in":"query","required":false,"schema":{"type":"string"}},{"name":"conversion_started_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"conversion_finished_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"job_locked_host","in":"query","required":false,"schema":{"type":"string"}},{"name":"job_locked_pid","in":"query","required":false,"schema":{"type":"string"}},{"name":"transcription_status","in":"query","required":false,"schema":{"type":"string","enum":["transcribed","transcription_in_progress","not_transcribed"]}},{"name":"unused","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"aspect_ratio","in":"query","required":false,"schema":{"type":"string","enum":["ratio_16_9","ratio_9_16","ratio_4_5","ratio_5_4","ratio_4_3","ratio_3_4","square","portrait","landscape"]}}]}},"/api/v2/assets/{id}/scaled_url":{"get":{"summary":"Get a scaled image URL","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"url":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Generates a URL for a scaled version of an image asset at the given dimensions.\n\nAt least one of `width` or `height` must be provided. When both are given, `constrain`\ndetermines how the image is fit into the box.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"width","in":"query","required":false,"schema":{"type":"integer","description":"Desired width in pixels."},"description":"Desired width in pixels."},{"name":"height","in":"query","required":false,"schema":{"type":"integer","description":"Desired height in pixels."},"description":"Desired height in pixels."},{"name":"constrain","in":"query","required":false,"schema":{"type":"string","enum":["fit","fill","crop"],"description":"How to constrain the image when both width and height are given. Defaults to `fit`. `fit` keeps the image inside the box; `fill` covers the box (one dimension may exceed it); `crop` covers and crops to the box."},"description":"How to constrain the image when both width and height are given. Defaults to `fit`. `fit` keeps the image inside the box; `fill` covers the box (one dimension may exceed it); `crop` covers and crops to the box."},{"name":"convert","in":"query","required":false,"schema":{"type":"string","enum":["webp"],"description":"Convert the image to a different format."},"description":"Convert the image to a different format."},{"name":"retina","in":"query","required":false,"schema":{"type":"boolean","description":"Generate a 2x retina-sized URL."},"description":"Generate a 2x retina-sized URL."}]}},"/api/v2/assets/{id}":{"get":{"summary":"Get a media file","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Asset"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/assets/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/assets/{id}/actions/restart_encoding":{"post":{"summary":"Restart encoding","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/force_restart_encoding":{"post":{"summary":"Force restart encoding (will restart if any service job is not locked)","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/apply_loudness_filter":{"post":{"summary":"Normalize audio levels","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/deepgram":{"post":{"summary":"Transcribe","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string"},"diarize":{"type":"string"},"merge_summary":{"type":"string"}}}}}}}},"/api/v2/assets/{id}/actions/extract_text":{"post":{"summary":"Extract text","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/assets/{id}/actions/recreate_bookmarks":{"post":{"summary":"Regenerate bookmarks from transcript","tags":["Assets"],"x-simplero-resource-type":"assets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations":{"get":{"summary":"List automations","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Automation"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"object_type","in":"query","required":false,"schema":{"type":"string","enum":["Customer","Subscription","OptIn","Entrant","Purchase","EventOccurrenceParticipant","Deal","Affiliate","SurveyResponse","WorksheetResponse","CoachingClient","Ticket","SiteMember","SiteGroupRequest"]}},{"name":"force_customer","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"always_run","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"allow_duplicate_active_contact","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]},"post":{"summary":"Create a automation","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Automation"}}}}}},"/api/v2/automations/{id}":{"get":{"summary":"Get a automation","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a automation","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Automation"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AutomationOptional"}}}}}},"/api/v2/automations/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/automations/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/automations/{id}/actions/star":{"post":{"summary":"Star","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations/{id}/actions/duplicate_reuse":{"post":{"summary":"Duplicate \u0026 reuse same Library Emails","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/automations/{id}/actions/duplicate_copy":{"post":{"summary":"Duplicate \u0026 also duplicate Library Emails","tags":["Automations"],"x-simplero-resource-type":"automations","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/availabilities":{"get":{"summary":"List availability presets","tags":["Availabilities"],"x-simplero-resource-type":"availabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Availability"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"owner_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a availability preset","tags":["Availabilities"],"x-simplero-resource-type":"availabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Availability"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Availability"}}}}}},"/api/v2/availabilities/{id}":{"get":{"summary":"Get a availability preset","tags":["Availabilities"],"x-simplero-resource-type":"availabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Availability"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a availability preset","tags":["Availabilities"],"x-simplero-resource-type":"availabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Availability"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AvailabilityOptional"}}}}}},"/api/v2/availabilities/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Availabilities"],"x-simplero-resource-type":"availabilities","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/countdown_instances":{"get":{"summary":"List countdown instances","tags":["Countdown Instances"],"x-simplero-resource-type":"countdown_instances","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CountdownInstance"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"countdown_timer_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/countdown_instances/{id}":{"get":{"summary":"Get a countdown instance","tags":["Countdown Instances"],"x-simplero-resource-type":"countdown_instances","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CountdownInstance"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/countdown_timers":{"get":{"summary":"List countdown timers","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CountdownTimer"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true}]},"post":{"summary":"Create a countdown timer","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CountdownTimer"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountdownTimer"}}}}}},"/api/v2/countdown_timers/{id}":{"get":{"summary":"Get a countdown timer","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CountdownTimer"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a countdown timer","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CountdownTimer"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CountdownTimerOptional"}}}}}},"/api/v2/countdown_timers/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/countdown_timers/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/countdown_timers/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Countdown Timers"],"x-simplero-resource-type":"countdown_timers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/coupons":{"get":{"summary":"List coupons","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Coupon"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"state","in":"query","required":false,"schema":{"type":"string","enum":["available","future","expired","used_up"]}}]},"post":{"summary":"Create a coupon","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Coupon"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Coupon"}}}}}},"/api/v2/coupons/{id}":{"get":{"summary":"Get a coupon","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Coupon"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a coupon","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Coupon"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CouponOptional"}}}}}},"/api/v2/coupons/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/coupons/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/coupons/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/coupons/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Coupons"],"x-simplero-resource-type":"coupons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons":{"get":{"summary":"List lessons","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourseLesson"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"course_module_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"publish_status","in":"query","required":false,"schema":{"type":"string","enum":["draft","published","scheduled","dripped"]}},{"name":"transcription_status","in":"query","required":false,"schema":{"type":"string","enum":["yes","progress","no"]}}]},"post":{"summary":"Create a lesson","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseLesson"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseLesson"}}}}}},"/api/v2/course_lessons/{id}":{"get":{"summary":"Get a lesson","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseLesson"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a lesson","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseLesson"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseLessonOptional"}}}}}},"/api/v2/course_lessons/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/set_author":{"post":{"summary":"Set author","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"author_id":{"type":"integer","description":"Author"}}}}}}}},"/api/v2/course_lessons/{id}/actions/update_show_unauthorized_course":{"post":{"summary":"Change no access to COURSE behavior","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"show_unauthorized_course":{"type":"string"}}}}}}}},"/api/v2/course_lessons/{id}/actions/update_show_unauthorized_lesson":{"post":{"summary":"Change no access to LESSON behavior","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"show_unauthorized_lesson":{"type":"string"}}}}}}}},"/api/v2/course_lessons/{id}/actions/update_unauthorized_message":{"post":{"summary":"Change alternative content when no access to lesson","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"unauthorized_message":{"type":"string"}}}}}}}},"/api/v2/course_lessons/{id}/actions/enable_preferred_playback_rate":{"post":{"summary":"Start at user preferred speed","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/disable_preferred_playback_rate":{"post":{"summary":"Start at 1x speed","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/allow_multiple_completions":{"post":{"summary":"Allow multiple completions","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/disallow_multiple_completions":{"post":{"summary":"Disallow multiple completions","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/publish":{"post":{"summary":"Publish","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/unpublish":{"post":{"summary":"Unpublish","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/move_module":{"post":{"summary":"Move to module","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_module_id":{"type":"integer","description":"CourseModule"}}}}}}}},"/api/v2/course_lessons/{id}/actions/deepgram":{"post":{"summary":"Transcribe video/audio lessons","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string"},"diarize":{"type":"string"},"merge_summary":{"type":"string"}}}}}}}},"/api/v2/course_lessons/{id}/actions/recreate_bookmarks":{"post":{"summary":"Regenerate bookmarks from transcript","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/regenerate_ai_description":{"post":{"summary":"Regenerate AI description","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/delete_ai_generated_summary":{"post":{"summary":"Delete AI generated summary","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/apply_loudness_filter":{"post":{"summary":"Apply loudness filter","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/start_from_beginning":{"post":{"summary":"Always start media from the beginning","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/resume_from_last_position":{"post":{"summary":"Resume media from the last position","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_lessons/{id}/actions/update_loop_asset":{"post":{"summary":"Update lesson asset loop","tags":["Course Lessons"],"x-simplero-resource-type":"course_lessons","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"loop_asset":{"type":"string"}}}}}}}},"/api/v2/course_modules":{"get":{"summary":"List modules","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CourseModule"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"course_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a module","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseModule"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseModule"}}}}}},"/api/v2/course_modules/{id}":{"get":{"summary":"Get a module","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseModule"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a module","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CourseModule"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseModuleOptional"}}}}}},"/api/v2/course_modules/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/course_modules/{id}/actions/restart_all_members":{"post":{"summary":"Restart module for all members","tags":["Course Modules"],"x-simplero-resource-type":"course_modules","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses":{"get":{"summary":"List courses","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Course"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"site_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"publish_status","in":"query","required":false,"schema":{"type":"string","enum":["draft","published","scheduled","drip"]}}]},"post":{"summary":"Create a course","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Course"}}}}}},"/api/v2/courses/{id}":{"get":{"summary":"Get a course","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a course","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Course"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CourseOptional"}}}}}},"/api/v2/courses/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/courses/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/courses/{id}/actions/publish":{"post":{"summary":"Publish","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/drip":{"post":{"summary":"Drip","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"grant":{"type":"boolean"}}}}}}}},"/api/v2/courses/{id}/actions/unpublish":{"post":{"summary":"Unpublish","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/move_to_other_site":{"post":{"summary":"Move to other site","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/courses/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/duplicate_to_other_site":{"post":{"summary":"Duplicate to other site","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/courses/{id}/actions/grant_access":{"post":{"summary":"Grant access","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_ids":{"type":"array","items":{"type":"integer"},"description":"Customer"},"also_site":{"type":"boolean"},"send_email":{"type":"boolean"}}}}}}}},"/api/v2/courses/{id}/actions/prevent_downloads":{"post":{"summary":"Prevent downloads","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/allow_downloads":{"post":{"summary":"Allow downloads","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/enable_autoplay":{"post":{"summary":"Enable autoplay","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/disable_autoplay":{"post":{"summary":"Disable autoplay","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/refresh_card_image":{"post":{"summary":"Refresh card image","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/hide_content_duration":{"post":{"summary":"Hide content duration","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/show_content_duration":{"post":{"summary":"Show content duration","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/hide_content_counts":{"post":{"summary":"Hide content counts","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/show_content_counts":{"post":{"summary":"Show content counts","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/hide_from_index":{"post":{"summary":"Hide from the Site Course directory page","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/show_on_index":{"post":{"summary":"Show on the Site Course directory page","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/exclude_from_new_content":{"post":{"summary":"Exclude from \"New content\" blocks","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/include_in_new_content":{"post":{"summary":"Include in \"New content\" blocks","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/on_site_tease":{"post":{"summary":"Set On-Site Upsell mode to Tease","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/on_site_hide":{"post":{"summary":"Set On-Site Upsell mode to Hide","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/delete_ai_generated_summaries":{"post":{"summary":"Delete AI generated summaries for all lessons","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/courses/{id}/actions/deepgram":{"post":{"summary":"Transcribe video/audio lessons","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"language":{"type":"string"},"diarize":{"type":"string"},"merge_summary":{"type":"string"}}}}}}}},"/api/v2/courses/{id}/actions/restart_all_members":{"post":{"summary":"Restart course progress for all members","tags":["Courses"],"x-simplero-resource-type":"courses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customer_notes":{"get":{"summary":"List notes","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/CustomerNote"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"customer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"user_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"kind","in":"query","required":false,"schema":{"type":"string"}},{"name":"private","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]},"post":{"summary":"Create a note","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerNote"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerNote"}}}}}},"/api/v2/customer_notes/{id}":{"get":{"summary":"Get a note","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerNote"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a note","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/CustomerNote"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerNoteOptional"}}}}}},"/api/v2/customer_notes/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customer_notes/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/customer_notes/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Customer Notes"],"x-simplero-resource-type":"customer_notes","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/customers":{"get":{"summary":"List contacts","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Customer"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"first_names","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"last_name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"email","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"affiliate_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"tag_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"badge_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"segment_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"automation_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"geo_country_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"geographic","in":"query","required":false,"schema":{"$ref":"#/components/schemas/GeoFilter"},"style":"deepObject","explode":true},{"name":"is_bad_name","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"subscribed_to","in":"query","required":false,"schema":{"type":"object","properties":{"list_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"unsubscribed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"subscribed_any","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"purchased_any","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"purchased_any_active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["customers","leads","clients"]}},{"name":"do_not_contact","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"do_not_sms","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"email_bounced","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"cold_contact","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RelativeDateFilter"},"style":"deepObject","explode":true},{"name":"cold_contact_check","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"last_warmed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/RelativeDateFilter"},"style":"deepObject","explode":true},{"name":"timezone","in":"query","required":false,"schema":{"type":"string"}},{"name":"landing_page_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"affiliate_sold_any","in":"query","required":false,"schema":{"type":"object","properties":{"affiliate_program_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"list_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"product_as_purchaser","in":"query","required":false,"schema":{"type":"object","properties":{"product_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"product_as_participant","in":"query","required":false,"schema":{"type":"object","properties":{"product_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"subject_to_gdpr","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"has_store_credit","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"has_credits","in":"query","required":false,"schema":{"type":"string"}},{"name":"ever_had_credit","in":"query","required":false,"schema":{"type":"string"}},{"name":"ever_used_credit","in":"query","required":false,"schema":{"type":"string"}},{"name":"funnel_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"step_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"missed_by_auto_response_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"has_note_containing","in":"query","required":false,"schema":{"type":"string"}},{"name":"flow_any_running","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"lifetime_value_cents_excl_tax","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"opened_emails","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"clicked_emails","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"opened_emails_in_automation","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"clicked_emails_in_automation","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"lead_score","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"trial_or_activated_account","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"interactions_status","in":"query","required":false,"schema":{"type":"string","enum":["unread","starred"]}},{"name":"pipeline_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"pipeline_stage_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"deal_in_pipeline","in":"query","required":false,"schema":{"type":"object","properties":{"pipeline_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","blank","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"deal_in_stage","in":"query","required":false,"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","blank","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"duplicate_emails","in":"query","required":false,"schema":{"type":"string","enum":["within_filters","in_account"]}},{"name":"countdown_timer_running","in":"query","required":false,"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"},"sign":{"type":"string","enum":["ago","from_now"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"countdown_timer_completed","in":"query","required":false,"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"},"sign":{"type":"string","enum":["ago","from_now"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"countdown_timer_canceled","in":"query","required":false,"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"site_member_last_login","in":"query","required":false,"schema":{"type":"object","properties":{"site_id":{"type":"string"},"date_comparison":{"type":"string","enum":["","blank","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"style":"deepObject","explode":true},{"name":"utm_campaign_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_campaign_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true}]},"post":{"summary":"Create a contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Customer"}}}}}},"/api/v2/customers/{id}":{"get":{"summary":"Get a contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Customer"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CustomerOptional"}}}}}},"/api/v2/customers/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/send_a_broadcast":{"post":{"summary":"Send a broadcast","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/clean_name":{"post":{"summary":"Fix repeating name (e.g. \"John Smith Smith\")","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/send_password_reset":{"post":{"summary":"Send password reset","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/send_simplero_id":{"post":{"summary":"Send Simplero ID","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/remove_simplero_id":{"post":{"summary":"Remove Simplero ID","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/set_affiliate":{"post":{"summary":"Set Affiliate for Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"affiliate_id":{"type":"integer","description":"Affiliate"}}}}}}}},"/api/v2/customers/{id}/actions/remove_affiliate":{"post":{"summary":"Remove Affiliate for Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/send_chat_message":{"post":{"summary":"Send chat message","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"},"message":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/add_to_affiliate_program":{"post":{"summary":"Add to affiliate program","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"affiliate_program_id":{"type":"integer","description":"AffiliateProgram"}}}}}}}},"/api/v2/customers/{id}/actions/give_consent":{"post":{"summary":"Give GDPR consent","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/revoke_consent":{"post":{"summary":"Revoke GDPR consent","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/notice":{"post":{"summary":"Display notice","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"notice_id":{"type":"integer","description":"Notice"},"start_at":{"type":"string","format":"date-time"},"end_at":{"type":"string","format":"date-time"}}}}}}}},"/api/v2/customers/{id}/actions/task":{"post":{"summary":"Assign a task","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string"},"user_id":{"type":"integer","description":"User"},"relative_time_unit":{"type":"string"},"relative_time_count":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/email":{"post":{"summary":"Send notification email","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string"},"subject":{"type":"string"},"message":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/text_message":{"post":{"summary":"Send notification text message","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"number":{"type":"string"},"message":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/mailchimp_subscribe":{"post":{"summary":"Subscribe to a list in Mailchimp","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mailchimp_list_id":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/mailchimp_unsubscribe":{"post":{"summary":"Unsubscribe from a list in Mailchimp","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mailchimp_list_id":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/add_badge":{"post":{"summary":"Add engagement badge","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"badge_id":{"type":"integer","description":"Badge"}}}}}}}},"/api/v2/customers/{id}/actions/remove_badge":{"post":{"summary":"Remove engagement badge","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"badge_id":{"type":"integer","description":"Badge"}}}}}}}},"/api/v2/customers/{id}/actions/zapier_send_customer":{"post":{"summary":"Trigger zap with customer","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/zapier_send_target":{"post":{"summary":"Trigger zap with purchase","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"url":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/set_date_to_now":{"post":{"summary":"Set date field to relative time","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"field_id":{"type":"integer","description":"Field"},"delta_unit":{"type":"string"},"delta_sign":{"type":"integer"},"delta_count":{"type":"integer"}}}}}}}},"/api/v2/customers/{id}/actions/set_text_field":{"post":{"summary":"Set text field","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"field_id":{"type":"integer","description":"Field"},"text_value":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/start_automation":{"post":{"summary":"Start automation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automation_id":{"type":"integer","description":"Automation"}}}}}}}},"/api/v2/customers/{id}/actions/stop_automation":{"post":{"summary":"Stop automation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automation_id":{"type":"integer","description":"Automation"},"on_customer":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/pause_automation":{"post":{"summary":"Pause automation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automation_id":{"type":"integer","description":"Automation"},"on_customer":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/resume_automation":{"post":{"summary":"Resume automation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automation_id":{"type":"integer","description":"Automation"},"on_customer":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/continue_automation":{"post":{"summary":"Continue automation now","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"automation_id":{"type":"integer","description":"Automation"},"on_customer":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/stop_all_automations":{"post":{"summary":"Stop all automations for Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/pause_all_automations":{"post":{"summary":"Pause all automations for Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/start_countdown_timer":{"post":{"summary":"Start countdown timer","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"integer","description":"CountdownTimer"}}}}}}}},"/api/v2/customers/{id}/actions/extend_countdown_timer":{"post":{"summary":"Extend countdown timer","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"integer","description":"CountdownTimer"},"extend_by_unit":{"type":"string"},"extend_by_count":{"type":"integer"},"extend_by_sign":{"type":"integer"},"extend_by_seconds":{"type":"integer"}}}}}}}},"/api/v2/customers/{id}/actions/cancel_countdown_timer":{"post":{"summary":"Cancel countdown timer","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"countdown_timer_id":{"type":"integer","description":"CountdownTimer"}}}}}}}},"/api/v2/customers/{id}/actions/mark_as_do_not_contact":{"post":{"summary":"Mark as Do Not Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/unmark_as_do_not_contact":{"post":{"summary":"Unmark as Do Not Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/mark_as_archived":{"post":{"summary":"Archive Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/mark_as_unarchived":{"post":{"summary":"Unarchive Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/mark_as_warm":{"post":{"summary":"Mark Contact engaged","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/mark_as_cold":{"post":{"summary":"Mark Contact unengaged","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/unsubscribe_everything":{"post":{"summary":"Unsubscribe from everything","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/register_for_an_event":{"post":{"summary":"Register for an event","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_occurrence_id":{"type":"integer","description":"EventOccurrence"}}}}}}}},"/api/v2/customers/{id}/actions/register_for_next_occurrence":{"post":{"summary":"Register for next upcoming occurrence of event","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_id":{"type":"integer","description":"Event"}}}}}}}},"/api/v2/customers/{id}/actions/deregister_for_next_occurrence":{"post":{"summary":"Cancel registration for next upcoming occurrence of event","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_id":{"type":"integer","description":"Event"}}}}}}}},"/api/v2/customers/{id}/actions/approve_registration_for_an_event":{"post":{"summary":"Approve registration for an event","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_occurrence_id":{"type":"integer","description":"EventOccurrence"}}}}}}}},"/api/v2/customers/{id}/actions/deny_registration_for_an_event":{"post":{"summary":"Deny registration for an event (if pending)","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_occurrence_id":{"type":"integer","description":"EventOccurrence"}}}}}}}},"/api/v2/customers/{id}/actions/cancel_registration_for_an_event":{"post":{"summary":"Cancel registration for an event (if approved)","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"event_occurrence_id":{"type":"integer","description":"EventOccurrence"}}}}}}}},"/api/v2/customers/{id}/actions/credit_issue":{"post":{"summary":"Issue credits","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"credit_id":{"type":"integer","description":"Credit"},"amount":{"type":"string"},"explanation":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/credit_consume":{"post":{"summary":"Consume credits","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"credit_id":{"type":"integer","description":"Credit"},"amount":{"type":"string"},"explanation":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/create_deal":{"post":{"summary":"Create deal in pipeline","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_id":{"type":"integer","description":"Pipeline"},"name":{"type":"string"},"description":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/move_deal":{"post":{"summary":"Move deal to pipeline stage","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/customers/{id}/actions/space_grant":{"post":{"summary":"Give access to space","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"space_id":{"type":"integer","description":"Space"}}}}}}}},"/api/v2/customers/{id}/actions/space_revoke":{"post":{"summary":"Revoke access to space","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"space_id":{"type":"integer","description":"Space"}}}}}}}},"/api/v2/customers/{id}/actions/category_grant":{"post":{"summary":"Give access to page","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"category_id":{"type":"integer","description":"Category"}}}}}}}},"/api/v2/customers/{id}/actions/category_revoke":{"post":{"summary":"Revoke access to page","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"category_id":{"type":"integer","description":"Category"}}}}}}}},"/api/v2/customers/{id}/actions/webhook":{"post":{"summary":"Post to webhook","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"outgoing_webhook_id":{"type":"integer","description":"OutgoingWebhook"}}}}}}}},"/api/v2/customers/{id}/actions/customer_sms":{"post":{"summary":"Send text message","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/product_purchase":{"post":{"summary":"Purchase product without paying","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"}}}}}}}},"/api/v2/customers/{id}/actions/product_cancel":{"post":{"summary":"Cancel existing purchase of product","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"}}}}}}}},"/api/v2/customers/{id}/actions/product_pause":{"post":{"summary":"Pause existing purchase of product","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"}}}}}}}},"/api/v2/customers/{id}/actions/product_resume":{"post":{"summary":"Resume existing purchase of product","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"}}}}}}}},"/api/v2/customers/{id}/actions/bulk_purchase":{"post":{"summary":"Create paid purchase","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"price_period_id":{"type":"integer","description":"PricePeriod"},"date":{"type":"string"},"current_user":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/product_add_paid_purchase":{"post":{"summary":"Add paid purchase to a product","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"price_id":{"type":"integer","description":"Price"}}}}}}}},"/api/v2/customers/{id}/actions/product_reset_auto_responses":{"post":{"summary":"Reset auto-responses for a product participant","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"}}}}}}}},"/api/v2/customers/{id}/actions/add_tag":{"post":{"summary":"Add a tag","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag_id":{"type":"integer","description":"Tag"}}}}}}}},"/api/v2/customers/{id}/actions/remove_tag":{"post":{"summary":"Remove a tag","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tag_id":{"type":"integer","description":"Tag"}}}}}}}},"/api/v2/customers/{id}/actions/remove_all_tags":{"post":{"summary":"Remove all tags","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/adjust_lead_score":{"post":{"summary":"Adjust lead score","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"amount":{"type":"integer"},"explanation":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/list_subscribe":{"post":{"summary":"Subscribe to list","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"},"skip_welcome":{"type":"boolean"},"skip_auto_responses":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/list_unsubscribe":{"post":{"summary":"Unsubscribe from list","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"}}}}}}}},"/api/v2/customers/{id}/actions/list_resubscribe":{"post":{"summary":"Resubscribe to list","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"}}}}}}}},"/api/v2/customers/{id}/actions/list_unsubscribe_all":{"post":{"summary":"Unsubscribe from all lists","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/subscription_suspend":{"post":{"summary":"Suspend subscription to list","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"}}}}}}}},"/api/v2/customers/{id}/actions/subscription_resume":{"post":{"summary":"Resume subscription to list","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"}}}}}}}},"/api/v2/customers/{id}/actions/list_reset_auto_responses":{"post":{"summary":"Reset auto-responses for a list subscriber","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"list_id":{"type":"integer","description":"List"}}}}}}}},"/api/v2/customers/{id}/actions/site_grant":{"post":{"summary":"Give access to site","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"},"send_login_email":{"type":"boolean"}}}}}}}},"/api/v2/customers/{id}/actions/site_revoke":{"post":{"summary":"Revoke access to site","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/customers/{id}/actions/idea_upvote":{"post":{"summary":"Upvote idea","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"idea_id":{"type":"integer","description":"Idea"}}}}}}}},"/api/v2/customers/{id}/actions/page_grant":{"post":{"summary":"Give access to a page","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"integer","description":"Page"}}}}}}}},"/api/v2/customers/{id}/actions/page_revoke":{"post":{"summary":"Revoke access to a page","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"page_id":{"type":"integer","description":"Page"}}}}}}}},"/api/v2/customers/{id}/actions/site_group_grant":{"post":{"summary":"Give access to group","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_group_id":{"type":"integer","description":"SiteGroup"}}}}}}}},"/api/v2/customers/{id}/actions/site_group_revoke":{"post":{"summary":"Revoke access to group","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_group_id":{"type":"integer","description":"SiteGroup"}}}}}}}},"/api/v2/customers/{id}/actions/course_grant":{"post":{"summary":"Give access to a course","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_id":{"type":"integer","description":"Course"}}}}}}}},"/api/v2/customers/{id}/actions/course_revoke":{"post":{"summary":"Revoke access to a course","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_id":{"type":"integer","description":"Course"}}}}}}}},"/api/v2/customers/{id}/actions/course_module_grant":{"post":{"summary":"Give access to a course module","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_module_id":{"type":"integer","description":"CourseModule"}}}}}}}},"/api/v2/customers/{id}/actions/course_module_revoke":{"post":{"summary":"Revoke access to a course module","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_module_id":{"type":"integer","description":"CourseModule"}}}}}}}},"/api/v2/customers/{id}/actions/course_lesson_grant":{"post":{"summary":"Give access to a course lesson","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_lesson_id":{"type":"integer","description":"CourseLesson"}}}}}}}},"/api/v2/customers/{id}/actions/course_lesson_revoke":{"post":{"summary":"Revoke access to a course lesson","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"course_lesson_id":{"type":"integer","description":"CourseLesson"}}}}}}}},"/api/v2/customers/{id}/actions/spear_email":{"post":{"summary":"Send SPEAR email","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"},"sender_name":{"type":"string"},"sender_email":{"type":"string"},"sender_verified_email_id":{"type":"integer","description":"SenderVerifiedEmail"}}}}}}}},"/api/v2/customers/{id}/actions/single_action_library_mailing":{"post":{"summary":"Send email","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"subject":{"type":"string"},"body":{"type":"string"},"sender_name":{"type":"string"},"sender_email":{"type":"string"},"sender_verified_email_id":{"type":"integer","description":"SenderVerifiedEmail"},"mailing_id":{"type":"integer","description":"Mailing"},"reply_to":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/library_mailing":{"post":{"summary":"Send email from Library","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"mailing_id":{"type":"integer","description":"LibraryMailing"}}}}}}}},"/api/v2/customers/{id}/actions/request_signature":{"post":{"summary":"Request contract signature","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"contract_id":{"type":"integer","description":"Contract"},"send_email":{"type":"boolean"},"send_text":{"type":"boolean"},"email_subject":{"type":"string"},"email_body":{"type":"string"},"text_body":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/coaching_client_add":{"post":{"summary":"Add to coaching program","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"coaching_program_id":{"type":"integer","description":"CoachingProgram"}}}}}}}},"/api/v2/customers/{id}/actions/add_to_conversation":{"post":{"summary":"Add to Conversation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"conversation_id":{"type":"integer","description":"Conversation"}}}}}}}},"/api/v2/customers/{id}/actions/remove_from_conversation":{"post":{"summary":"Remove from Conversation","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"conversation_id":{"type":"integer","description":"Conversation"}}}}}}}},"/api/v2/customers/{id}/actions/podcast_grant":{"post":{"summary":"Give access to podcast","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"podcast_id":{"type":"integer","description":"Podcast"}}}}}}}},"/api/v2/customers/{id}/actions/podcast_revoke":{"post":{"summary":"Revoke access to podcast","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"podcast_id":{"type":"integer","description":"Podcast"}}}}}}}},"/api/v2/customers/{id}/actions/bot_tier_grant":{"post":{"summary":"Give access to bot tier","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bot_tier_id":{"type":"integer","description":"BotTier"}}}}}}}},"/api/v2/customers/{id}/actions/bot_tier_revoke":{"post":{"summary":"Revoke access to bot tier","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"bot_tier_id":{"type":"integer","description":"BotTier"}}}}}}}},"/api/v2/customers/{id}/actions/interactions":{"post":{"summary":"Go to Interactions for Contact","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/customers/{id}/actions/add_to_meta_custom_audience":{"post":{"summary":"Add to Meta custom audience","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"integer","description":"Integration"},"custom_audience_id":{"type":"string"}}}}}}}},"/api/v2/customers/{id}/actions/remove_from_meta_custom_audience":{"post":{"summary":"Remove from Meta custom audience","tags":["Customers"],"x-simplero-resource-type":"customers","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"integration_id":{"type":"integer","description":"Integration"},"custom_audience_id":{"type":"string"}}}}}}}},"/api/v2/deals":{"get":{"summary":"List deals","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Deal"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"pipeline_stage_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","won","lost","abandoned"]}},{"name":"name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"assignee_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"utm_campaign_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_campaign_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a deal","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Deal"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Deal"}}}}}},"/api/v2/deals/{id}":{"get":{"summary":"Get a deal","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Deal"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a deal","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Deal"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealOptional"}}}}}},"/api/v2/deals/{id}/actions/move_to_stage":{"post":{"summary":"Move to pipeline stage","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/deals/{id}/actions/move_to_pipeline":{"post":{"summary":"Move to pipeline","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/deals/{id}/actions/set_product_id":{"post":{"summary":"Set product","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"},"update_value":{"type":"boolean"}}}}}}}},"/api/v2/deals/{id}/actions/set_value":{"post":{"summary":"Set value","tags":["Deals"],"x-simplero-resource-type":"deals","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"value_cents":{"type":"integer"}}}}}}}},"/api/v2/event_occurrence_participants":{"get":{"summary":"List event participants","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventOccurrenceParticipant"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"registration_state","in":"query","required":false,"schema":{"type":"string","enum":[2,1,3,4,5,6,7]}},{"name":"attendance_status","in":"query","required":false,"schema":{"type":"string","enum":["attendees","absentees"]}},{"name":"registered_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"first_joined_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"last_joined_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"last_left_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"duration_attended_in_seconds","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"ip_address","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"referrer","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"ref","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"affiliate_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"affiliate_link_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"device_type","in":"query","required":false,"schema":{"type":"string","enum":[1,2]}},{"name":"screen_size","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"user_agent","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"request_locale","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_campaign","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"event_occurrence_status","in":"query","required":false,"schema":{"type":"string","enum":["not_ended_fixed","ended","canceled","without_fixed_time","not_ended"]}},{"name":"contract_signed","in":"query","required":false,"schema":{"type":"string","enum":["yes","no"]}},{"name":"contract_signed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true}]}},"/api/v2/event_occurrence_participants/{id}":{"get":{"summary":"Get a event participant","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventOccurrenceParticipant"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/approve_registration":{"post":{"summary":"Approve registration","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/deny_registration":{"post":{"summary":"Deny registration","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/cancel_registration":{"post":{"summary":"Cancel registration","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/cancel_booking":{"post":{"summary":"Cancel booking","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/resend_confirmation_email":{"post":{"summary":"Resend confirmation email","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrence_participants/{id}/actions/set_deal_assignee_to_scheduling_link_organizer":{"post":{"summary":"Set Deal Assignee to the organizer on the Scheduling Link","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_id":{"type":"integer","description":"Pipeline"}}}}}}}},"/api/v2/event_occurrence_participants/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Event Occurrence Participants"],"x-simplero-resource-type":"event_occurrence_participants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrences":{"get":{"summary":"List event occurrences","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EventOccurrence"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"starts_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"ends_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"event_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"site_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"registration_type","in":"query","required":false,"schema":{"type":"string","enum":[1,2,3]}},{"name":"approval_type","in":"query","required":false,"schema":{"type":"string","enum":[1,2,3]}},{"name":"event_type","in":"query","required":false,"schema":{"type":"string","enum":[1,3,2]}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["not_ended_recent","not_ended_fixed","ended","canceled","without_fixed_time","not_ended"]}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["regular","zoom"]}},{"name":"location_type","in":"query","required":false,"schema":{"type":"string","enum":["in_person","url","zoom","google_meet","microsoft_teams","simplero_live","tbd"]}},{"name":"host","in":"query","required":false,"schema":{"type":"string"}},{"name":"organizer","in":"query","required":false,"schema":{"type":"string"}},{"name":"booking_type","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"scheduling_link_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"funnel_step_id","in":"query","required":false,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrences/{id}":{"get":{"summary":"Get a event occurrence","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/EventOccurrence"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrences/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/add_facet_values":{"post":{"summary":"Add facet values","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/remove_facet_values":{"post":{"summary":"Remove facet values","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/cancel":{"post":{"summary":"Cancel","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/event_occurrences/{id}/actions/change_organizer":{"post":{"summary":"Change organizer","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"administratorship_id":{"type":"integer","description":"Administratorship"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/set_hosts":{"post":{"summary":"Set hosts","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_ids":{"type":"array","items":{"type":"integer"},"description":"User"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/add_to_site":{"post":{"summary":"Add event series to site(s)","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_ids":{"type":"array","items":{"type":"integer"},"description":"Site"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/remove_from_site":{"post":{"summary":"Remove event series from site(s)","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_ids":{"type":"array","items":{"type":"integer"},"description":"Site"}}}}}}}},"/api/v2/event_occurrences/{id}/actions/create_recording_lesson":{"post":{"summary":"Create recording lesson","tags":["Event Occurrences"],"x-simplero-resource-type":"event_occurrences","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/events":{"get":{"summary":"List events","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Event"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true}]},"post":{"summary":"Create a event","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Event"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Event"}}}}}},"/api/v2/events/{id}":{"get":{"summary":"Get a event","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Event"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a event","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Event"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventOptional"}}}}}},"/api/v2/events/{id}/actions/add_facet_values":{"post":{"summary":"Add facet values","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/events/{id}/actions/remove_facet_values":{"post":{"summary":"Remove facet values","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/events/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/events/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/events/{id}/actions/add_to_site":{"post":{"summary":"Add event series to site(s)","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_ids":{"type":"array","items":{"type":"integer"},"description":"Site"}}}}}}}},"/api/v2/events/{id}/actions/remove_from_site":{"post":{"summary":"Remove event series from site(s)","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_ids":{"type":"array","items":{"type":"integer"},"description":"Site"}}}}}}}},"/api/v2/events/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/events/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Events"],"x-simplero-resource-type":"events","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/field_option_values":{"get":{"summary":"List field option values","tags":["Field Option Values"],"x-simplero-resource-type":"field_option_values","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FieldOptionValue"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"field_value_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"field_option_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/field_option_values/{id}":{"get":{"summary":"Get a field option value","tags":["Field Option Values"],"x-simplero-resource-type":"field_option_values","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FieldOptionValue"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/field_options":{"get":{"summary":"List options","tags":["Field Options"],"x-simplero-resource-type":"field_options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FieldOption"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"field_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a option","tags":["Field Options"],"x-simplero-resource-type":"field_options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FieldOption"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldOption"}}}}}},"/api/v2/field_options/{id}":{"get":{"summary":"Get a option","tags":["Field Options"],"x-simplero-resource-type":"field_options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FieldOption"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a option","tags":["Field Options"],"x-simplero-resource-type":"field_options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FieldOption"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldOptionOptional"}}}}}},"/api/v2/field_options/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Field Options"],"x-simplero-resource-type":"field_options","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/field_values":{"get":{"summary":"List field values","tags":["Field Values"],"x-simplero-resource-type":"field_values","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"field_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"owner_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"owner_type","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/field_values/{id}":{"get":{"summary":"Get a field value","tags":["Field Values"],"x-simplero-resource-type":"field_values","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FieldValue"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/fields":{"get":{"summary":"List fields","tags":["Fields"],"x-simplero-resource-type":"fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Field"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"}]},"post":{"summary":"Create a field","tags":["Fields"],"x-simplero-resource-type":"fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Field"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Field"}}}}}},"/api/v2/fields/{id}":{"get":{"summary":"Get a field","tags":["Fields"],"x-simplero-resource-type":"fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Field"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a field","tags":["Fields"],"x-simplero-resource-type":"fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Field"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FieldOptional"}}}}}},"/api/v2/form_fields":{"get":{"summary":"List fields","tags":["Form Fields"],"x-simplero-resource-type":"form_fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FormField"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"field_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"owner_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"owner_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"purpose","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a field","tags":["Form Fields"],"x-simplero-resource-type":"form_fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormField"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormField"}}}}}},"/api/v2/form_fields/{id}":{"get":{"summary":"Get a field","tags":["Form Fields"],"x-simplero-resource-type":"form_fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormField"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a field","tags":["Form Fields"],"x-simplero-resource-type":"form_fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FormField"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormFieldOptional"}}}}}},"/api/v2/form_fields/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Form Fields"],"x-simplero-resource-type":"form_fields","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/funnel_connectors":{"post":{"summary":"Add a branch to a split or condition step","tags":["Funnel Connectors"],"x-simplero-resource-type":"funnel_connectors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelConnector"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"description":"Adds a new empty branch (connector) to a `split_test` or `condition` step.\nThe new connector goes from `parent_id` (the split/condition step) to that\nstep's paired join step, marked `created_blank: true`. Fill the branch by\ncreating steps with `connector_id` set to this connector's id.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"parent_id":{"type":"integer","description":"A split_test or condition step ID."}},"required":["parent_id"]}}}}},"get":{"summary":"List funnel connectors","tags":["Funnel Connectors"],"x-simplero-resource-type":"funnel_connectors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FunnelConnector"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"funnel_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/funnel_connectors/{id}":{"delete":{"summary":"Delete a funnel connector","tags":["Funnel Connectors"],"x-simplero-resource-type":"funnel_connectors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Removes a branch from a split or condition step. The branch must be empty\n— delete any steps inside it first via `DELETE /api/v2/funnel_steps/:id`.\n\nCannot delete the otherwise branch, or the last remaining non-otherwise branch.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"get":{"summary":"Get a funnel connector","tags":["Funnel Connectors"],"x-simplero-resource-type":"funnel_connectors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelConnector"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a funnel connector","tags":["Funnel Connectors"],"x-simplero-resource-type":"funnel_connectors","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelConnector"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelConnectorOptional"}}}}}},"/api/v2/funnel_steps":{"post":{"summary":"Create a funnel step","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelStep"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"description":"Create a new step in a funnel. The step is graph-aware: for `split_test` /\n`condition` step types, the paired join step and minimum connectors are\ncreated atomically.\n\nPlacement parameters (all optional, mutually exclusive):\n- `after_step_id` — insert after the given step (uses its child connector).\n- `before_step_id` — insert before the given step (uses its parent connector).\n- `connector_id` — insert into a specific connector (e.g. into a split branch).\n- None of the above — append before the funnel's `last` sentinel step.","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelStep"}}}}},"get":{"summary":"List funnel steps","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/FunnelStep"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"funnel_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/funnel_steps/{id}":{"get":{"summary":"Get a funnel step","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelStep"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a funnel step","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/FunnelStep"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelStepOptional"}}}}}},"/api/v2/funnel_steps/{id}/actions/move":{"post":{"summary":"Move","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"after_step_id":{"type":"integer","description":"FunnelStep"},"before_step_id":{"type":"integer","description":"FunnelStep"},"connector_id":{"type":"integer","description":"FunnelConnector"}}}}}}}},"/api/v2/funnel_steps/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"after_step_id":{"type":"integer","description":"FunnelStep"},"before_step_id":{"type":"integer","description":"FunnelStep"},"connector_id":{"type":"integer","description":"FunnelConnector"}}}}}}}},"/api/v2/funnel_steps/{id}/actions/archive":{"post":{"summary":"Archive","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/funnel_steps/{id}/actions/restore":{"post":{"summary":"Restore","tags":["Funnel Steps"],"x-simplero-resource-type":"funnel_steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"duplicate":{"type":"boolean"}}}}}}}},"/api/v2/funnels":{"get":{"summary":"List funnels","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Funnel"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]},"post":{"summary":"Create a funnel","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Funnel"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Funnel"}}}}}},"/api/v2/funnels/{id}":{"get":{"summary":"Get a funnel","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Funnel"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a funnel","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Funnel"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FunnelOptional"}}}}}},"/api/v2/funnels/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/funnels/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/funnels/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/funnels/{id}/actions/star":{"post":{"summary":"Star","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/funnels/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/funnels/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Funnels"],"x-simplero-resource-type":"funnels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/ideas":{"get":{"summary":"List ideas","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Idea"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"pipeline_stage_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","closed","done","duplicate"]}},{"name":"assignee_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"pipeline_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/ideas/{id}":{"get":{"summary":"Get a idea","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Idea"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a idea","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Idea"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IdeaOptional"}}}}}},"/api/v2/ideas/{id}/actions/move_to_stage":{"post":{"summary":"Move to pipeline stage","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/ideas/{id}/actions/move_to_pipeline":{"post":{"summary":"Move to pipeline","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/ideas/{id}/actions/add_facet_values":{"post":{"summary":"Add facet values","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/ideas/{id}/actions/remove_facet_values":{"post":{"summary":"Remove facet values","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/ideas/{id}/actions/assign_to_me":{"post":{"summary":"Assign to me","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/ideas/{id}/actions/reassign":{"post":{"summary":"Reassign","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"}}}}}}}},"/api/v2/ideas/{id}/actions/send_to_linear":{"post":{"summary":"Send to Linear","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/ideas/{id}/actions/merge":{"post":{"summary":"Merge into another idea","tags":["Ideas"],"x-simplero-resource-type":"ideas","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"target_idea_id":{"type":"integer","description":"Idea"}}}}}}}},"/api/v2/installments":{"get":{"summary":"List installments","tags":["Installments"],"x-simplero-resource-type":"installments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Installment"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"price_period_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a installment","tags":["Installments"],"x-simplero-resource-type":"installments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Installment"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Installment"}}}}}},"/api/v2/installments/{id}":{"get":{"summary":"Get a installment","tags":["Installments"],"x-simplero-resource-type":"installments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Installment"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a installment","tags":["Installments"],"x-simplero-resource-type":"installments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Installment"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/InstallmentOptional"}}}}}},"/api/v2/labelings":{"get":{"summary":"List labeled objects","tags":["Labelings"],"x-simplero-resource-type":"labelings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Labeling"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"labeled_object_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"labeled_object_type","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a labeled object","tags":["Labelings"],"x-simplero-resource-type":"labelings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Labeling"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Labeling"}}}}}},"/api/v2/labelings/{id}":{"get":{"summary":"Get a labeled object","tags":["Labelings"],"x-simplero-resource-type":"labelings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Labeling"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/labels":{"get":{"summary":"List labels","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Label"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}}]},"post":{"summary":"Create a label","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Label"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Label"}}}}}},"/api/v2/labels/{id}":{"get":{"summary":"Get a label","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Label"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a label","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Label"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LabelOptional"}}}}}},"/api/v2/labels/{id}/actions/star":{"post":{"summary":"Star","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/labels/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Labels"],"x-simplero-resource-type":"labels","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages":{"get":{"summary":"List landing pages","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LandingPage"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"page_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"cta_object_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"funnel","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"cta_object_list_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"cta_object_product_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"publish_status","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a landing page","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LandingPage"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPage"}}}}}},"/api/v2/landing_pages/{id}":{"get":{"summary":"Get a landing page","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LandingPage"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a landing page","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LandingPage"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LandingPageOptional"}}}}}},"/api/v2/landing_pages/{id}/builder/content/node_types":{"get":{"summary":"List available builder node types","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"name":{"type":"string","description":"Human-readable name of this node type, e.g. \"Headline\", \"Section\""},"category":{"type":"string","nullable":true,"description":"Category (e.g. General, Media, Layout); null for structural containers like section/row/column"}},"required":["type","name"]}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns node types that can be added to this builder doc. If parent_node_id is given, filters to types valid as children of that node.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"parent_node_id","in":"query","required":false,"schema":{"type":"string","description":"Limit to types valid as children of this node."},"description":"Limit to types valid as children of this node."}]}},"/api/v2/landing_pages/{id}/builder/content/node_types/detail":{"get":{"summary":"Get builder node type schema","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"name":{"type":"string","description":"Human-readable name of this node type, e.g. \"Headline\", \"Section\""},"settings":{"type":"array","items":{"type":"string"},"description":"Ids of settings available on this node type. Args schemas are not included here — use the node_types/settings_detail endpoint to fetch them."}},"required":["type","name","settings"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the node_types/settings_detail endpoint with the setting ids you care about.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"}]}},"/api/v2/landing_pages/{id}/builder/content/node_types/settings_detail":{"get":{"summary":"Get builder node type settings detail","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"object","properties":{"args":{"type":"object","additionalProperties":{"type":"object","properties":{"default":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Default value for this arg"},"type":{"type":"string","nullable":true,"description":"Ruby type for the arg, if known (e.g. String, Integer)"},"acceptable_values":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Arg value — arbitrary JSON scalar, object, or array. Shape depends on the specific setting and arg."},"nullable":true,"description":"Accepted values for enum-like args. Omitted when the arg does not restrict to a specific set."},"description":{"type":"string","nullable":true,"description":"Natural-language description of the arg. When the arg is only relevant under certain conditions, that is prepended as a sentence (e.g. \"Only when by_tag is true.\")."}}},"description":"Arg name → { default, type }. Uses these defaults when omitting args under a breakpoint."}},"required":["args"]},"description":"Setting id → { args }."}},"required":["data"]}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},{"name":"setting_ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"Setting ids to describe. Pass one or more. Accepts either a repeated array param (setting_ids[]=a\u0026setting_ids[]=b) or a single comma-separated string (setting_ids=a,b)."},"description":"Setting ids to describe. Pass one or more. Accepts either a repeated array param (setting_ids[]=a\u0026setting_ids[]=b) or a single comma-separated string (setting_ids=a,b)."}]}},"/api/v2/landing_pages/{id}/builder/content/nodes":{"get":{"summary":"Get the builder doc node tree","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"Root node of the tree; recursively contains children."}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the full working-version node tree for this record.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"post":{"summary":"Create a builder doc node","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The created node, including its generated id."}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Adds a new node to the tree under the given parent. Pass publish_changes: true to publish the working version immediately. Note: creating an `html_section` node here is allowed but you MUST NOT pass any `settings` — to set its HTML content, create it first and then use the html_section update endpoint (POST builder/content/html_section).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"parent_node_id":{"type":"string","description":"Id of the parent node"},"after_node_id":{"type":"string","nullable":true,"description":"If set, insert after this sibling; otherwise appended"},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to leave unnamed."},"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Initial setting values keyed by setting id. All settings/breakpoints/args are optional."},"publish_changes":{"type":"boolean","description":"Publish the working version after creation"}},"required":["type","parent_node_id"]}}}}}},"/api/v2/landing_pages/{id}/builder/content/nodes/{node_id}":{"get":{"summary":"Get a builder doc node","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The node."}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns a single node by id from the working version.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a builder doc node","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The updated node."}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publish_changes: true to publish the working version immediately. Note: `html_section` nodes cannot be updated via this endpoint — use the html_section update endpoint (POST builder/content/html_section) instead.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Setting values keyed by setting id. Deep-merged into the node — only keys you pass are touched."},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to preserve the current value."},"meta":{"type":"object","description":"Meta values to merge into the node. Free-form bag of keys/values."},"publish_changes":{"type":"boolean","description":"Publish the working version after update"}}}}}}},"delete":{"summary":"Delete a builder doc node","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Removes a node from the tree. Pass publish_changes: true to publish the working version immediately.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"publish_changes","in":"query","required":false,"schema":{"type":"boolean","description":"Publish the working version after deletion"},"description":"Publish the working version after deletion"}]}},"/api/v2/landing_pages/{id}/builder/content/html_section/embed":{"post":{"summary":"Generate embed markup for a node type","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"embed_html":{"type":"string","description":"\u003cbuilder-node\u003e markup that you can use in an html section's html"}},"required":["embed_html"]}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns a \u003cbuilder-node\u003e custom element markup string that you can paste into the html of an html_section to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML.\n\nHow to use:\n  1. Use the node_types endpoints for this builder role to find the `type` of the node you want to embed and its available settings.\n  2. POST here with that `type` and any `settings` you want baked in. The response contains `embed_html` — a self-contained \u003cbuilder-node ...\u003e\u003c/builder-node\u003e snippet.\n  3. Paste that `embed_html` string verbatim into the `html` you send to the html_section update endpoint (POST builder/content/html_section). At runtime it will be replaced with the rendered node.\n\nTypical flow: build the bulk of your page as HTML via the html_section update endpoint, and sprinkle in these \u003cbuilder-node\u003e embeds wherever you need a dynamic Simplero element (order form, opt-in form, buy button, etc.) that you can't express as plain HTML.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Setting values keyed by setting id. All settings/breakpoints/args are optional."}},"required":["type"]}}}}}},"/api/v2/landing_pages/{id}/builder/content/html_section":{"post":{"summary":"Create or update HTML section content","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"node_id":{"type":"string","description":"The id of the html_section node."},"name":{"type":"string","nullable":true,"description":"User-assigned name of this node, if set."},"html":{"type":"string","description":"The full HTML content of the section."}},"required":["node_id","html"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Create or update the HTML content of an html_section node.\n\n`node_id` is required. Pass either:\n  * The id of an existing `html_section` node — updates its HTML.\n  * The literal string `\"create_new\"` — creates a new `html_section` node under the root with the given `html`.\n\nPass `publish_changes: true` to publish the working version immediately after the change.\n\nEmbedding structured builder nodes inside the HTML:\n  You can embed dynamic Simplero elements (order forms, opt-in forms, buttons, input fields, etc.) inside the HTML. See the description of the html_section embed endpoint (POST builder/content/html_section/embed) for how this works.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"html":{"type":"string","description":"The HTML content to set. CSS rules MUST be wrapped in \u003cstyle\u003e tags — the system extracts them into a separate style field automatically. Never write bare CSS (e.g. `:root { }`, `.class { }`) as plain text in the body; it will be treated as visible text content, not styles. Inline style=\"\" attributes on elements are fine."},"node_id":{"type":"string","description":"The id of the html_section node to update, or \"create_new\" to create a new one."},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to preserve the current value (or leave unnamed when creating a new section)."},"publish_changes":{"type":"boolean","description":"Publish the working version after the change."}},"required":["html","node_id"]}}}}},"get":{"summary":"Get HTML section content","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the html_section node."},"name":{"type":"string","nullable":true,"description":"User-assigned name of this node, if set."},"html":{"type":"string","description":"The full HTML content of the section."}},"required":["id","html"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the HTML content of the html_section node with the given id.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"query","required":true,"schema":{"type":"string","description":"The id of the html_section node to fetch."},"description":"The id of the html_section node to fetch."}]}},"/api/v2/landing_pages/{id}/builder/content/publish":{"post":{"summary":"Publish the working version","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Publishes the current working version of this record's builder doc, making staged changes live.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/landing_pages/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/landing_pages/{id}/actions/star":{"post":{"summary":"Star","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/create_funnel_from":{"post":{"summary":"Turn into a Funnel","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/move_to_funnel":{"post":{"summary":"Move to funnel","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"funnel_id":{"type":"integer","description":"Funnel"}}}}}}}},"/api/v2/landing_pages/{id}/actions/move_to_site":{"post":{"summary":"Move to Site Page","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/landing_pages/{id}/actions/undo_move":{"post":{"summary":"Undo move to landing page","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/convert_to_builder_v2":{"post":{"summary":"Convert to Page Builder 2.0","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/save_as_template":{"post":{"summary":"Save as template","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/refresh_page_speed_score":{"post":{"summary":"Refresh page speed score","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/landing_pages/{id}/actions/start_split_testing":{"post":{"summary":"Start split test","tags":["Landing Pages"],"x-simplero-resource-type":"landing_pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/library_mailings":{"get":{"summary":"List library emails","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/LibraryMailing"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"subject","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"email_template_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"delivered_to_count","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"usage_status","in":"query","required":false,"schema":{"type":"string","enum":["unused","single_use","shared"]}},{"name":"usage_count","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"automation_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"recipients_segment_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"object_type","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a library email","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LibraryMailing"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryMailing"}}}}}},"/api/v2/library_mailings/{id}":{"get":{"summary":"Get a library email","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LibraryMailing"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a library email","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/LibraryMailing"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LibraryMailingOptional"}}}}}},"/api/v2/library_mailings/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/library_mailings/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/library_mailings/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/library_mailings/{id}/actions/send_to":{"post":{"summary":"Send to","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"integer","description":"Customer"}}}}}}}},"/api/v2/library_mailings/{id}/actions/add_to_newsletter":{"post":{"summary":"Add to newsletter queue","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"broadcast_schedule_id":{"type":"integer","description":"BroadcastSchedule"}}}}}}}},"/api/v2/library_mailings/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/library_mailings/{id}/actions/star":{"post":{"summary":"Star","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/library_mailings/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Library Mailings"],"x-simplero-resource-type":"library_mailings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/lists":{"get":{"summary":"List lists","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/List"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}}]},"post":{"summary":"Create a list","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/List"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/List"}}}}}},"/api/v2/lists/{id}":{"get":{"summary":"Get a list","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/List"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a list","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/List"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOptional"}}}}}},"/api/v2/lists/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/lists/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/lists/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/lists/{id}/actions/star":{"post":{"summary":"Star","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/lists/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/lists/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Lists"],"x-simplero-resource-type":"lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/nav_list_links":{"get":{"summary":"List links","tags":["Nav List Links"],"x-simplero-resource-type":"nav_list_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NavListLink"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"nav_list_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a link","tags":["Nav List Links"],"x-simplero-resource-type":"nav_list_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NavListLink"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavListLink"}}}}}},"/api/v2/nav_list_links/{id}":{"get":{"summary":"Get a link","tags":["Nav List Links"],"x-simplero-resource-type":"nav_list_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NavListLink"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a link","tags":["Nav List Links"],"x-simplero-resource-type":"nav_list_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NavListLink"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/NavListLinkOptional"}}}}}},"/api/v2/nav_lists":{"get":{"summary":"List navigation lists","tags":["Nav Lists"],"x-simplero-resource-type":"nav_lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/NavList"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"site_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/nav_lists/{id}":{"get":{"summary":"Get a navigation list","tags":["Nav Lists"],"x-simplero-resource-type":"nav_lists","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/NavList"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages":{"get":{"summary":"List pages","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Page"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"publish_status","in":"query","required":false,"schema":{"type":"string","enum":["published","draft","drip","scheduled"]}},{"name":"page_type","in":"query","required":false,"schema":{"type":"string","enum":["builder","classic"]}},{"name":"slug","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"site_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Page"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page"}}}}}},"/api/v2/pages/{id}":{"get":{"summary":"Get a page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Page"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Page"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageOptional"}}}}}},"/api/v2/pages/{id}/builder/content/node_types":{"get":{"summary":"List available builder node types","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"name":{"type":"string","description":"Human-readable name of this node type, e.g. \"Headline\", \"Section\""},"category":{"type":"string","nullable":true,"description":"Category (e.g. General, Media, Layout); null for structural containers like section/row/column"}},"required":["type","name"]}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns node types that can be added to this builder doc. If parent_node_id is given, filters to types valid as children of that node.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"parent_node_id","in":"query","required":false,"schema":{"type":"string","description":"Limit to types valid as children of this node."},"description":"Limit to types valid as children of this node."}]}},"/api/v2/pages/{id}/builder/content/node_types/detail":{"get":{"summary":"Get builder node type schema","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"name":{"type":"string","description":"Human-readable name of this node type, e.g. \"Headline\", \"Section\""},"settings":{"type":"array","items":{"type":"string"},"description":"Ids of settings available on this node type. Args schemas are not included here — use the node_types/settings_detail endpoint to fetch them."}},"required":["type","name","settings"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the list of settings available on a single node type. Type is passed as a query param because it may contain slashes. To get the full args schema (defaults, types) for a specific setting, call the node_types/settings_detail endpoint with the setting ids you care about.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"}]}},"/api/v2/pages/{id}/builder/content/node_types/settings_detail":{"get":{"summary":"Get builder node type settings detail","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","additionalProperties":{"type":"object","properties":{"args":{"type":"object","additionalProperties":{"type":"object","properties":{"default":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Default value for this arg"},"type":{"type":"string","nullable":true,"description":"Ruby type for the arg, if known (e.g. String, Integer)"},"acceptable_values":{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Arg value — arbitrary JSON scalar, object, or array. Shape depends on the specific setting and arg."},"nullable":true,"description":"Accepted values for enum-like args. Omitted when the arg does not restrict to a specific set."},"description":{"type":"string","nullable":true,"description":"Natural-language description of the arg. When the arg is only relevant under certain conditions, that is prepended as a sentence (e.g. \"Only when by_tag is true.\")."}}},"description":"Arg name → { default, type }. Uses these defaults when omitting args under a breakpoint."}},"required":["args"]},"description":"Setting id → { args }."}},"required":["data"]}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the full args schema (defaults, types) for one or more settings of a given node type. Scoped by the node type. Returns a hash keyed by setting id.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"type","in":"query","required":true,"schema":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},{"name":"setting_ids","in":"query","required":true,"schema":{"type":"array","items":{"type":"string"},"description":"Setting ids to describe. Pass one or more. Accepts either a repeated array param (setting_ids[]=a\u0026setting_ids[]=b) or a single comma-separated string (setting_ids=a,b)."},"description":"Setting ids to describe. Pass one or more. Accepts either a repeated array param (setting_ids[]=a\u0026setting_ids[]=b) or a single comma-separated string (setting_ids=a,b)."}]}},"/api/v2/pages/{id}/builder/content/nodes":{"get":{"summary":"Get the builder doc node tree","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"Root node of the tree; recursively contains children."}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the full working-version node tree for this record.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"post":{"summary":"Create a builder doc node","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The created node, including its generated id."}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Adds a new node to the tree under the given parent. Pass publish_changes: true to publish the working version immediately. Note: creating an `html_section` node here is allowed but you MUST NOT pass any `settings` — to set its HTML content, create it first and then use the html_section update endpoint (POST builder/content/html_section).","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"parent_node_id":{"type":"string","description":"Id of the parent node"},"after_node_id":{"type":"string","nullable":true,"description":"If set, insert after this sibling; otherwise appended"},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to leave unnamed."},"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Initial setting values keyed by setting id. All settings/breakpoints/args are optional."},"publish_changes":{"type":"boolean","description":"Publish the working version after creation"}},"required":["type","parent_node_id"]}}}}}},"/api/v2/pages/{id}/builder/content/nodes/{node_id}":{"get":{"summary":"Get a builder doc node","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The node."}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns a single node by id from the working version.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a builder doc node","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/BuilderDocNode","description":"The updated node."}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Partial update — only the keys you pass are merged into the node. Settings are deep-merged. Pass publish_changes: true to publish the working version immediately. Note: `html_section` nodes cannot be updated via this endpoint — use the html_section update endpoint (POST builder/content/html_section) instead.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Setting values keyed by setting id. Deep-merged into the node — only keys you pass are touched."},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to preserve the current value."},"meta":{"type":"object","description":"Meta values to merge into the node. Free-form bag of keys/values."},"publish_changes":{"type":"boolean","description":"Publish the working version after update"}}}}}}},"delete":{"summary":"Delete a builder doc node","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Removes a node from the tree. Pass publish_changes: true to publish the working version immediately.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"publish_changes","in":"query","required":false,"schema":{"type":"boolean","description":"Publish the working version after deletion"},"description":"Publish the working version after deletion"}]}},"/api/v2/pages/{id}/builder/content/html_section/embed":{"post":{"summary":"Generate embed markup for a node type","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"embed_html":{"type":"string","description":"\u003cbuilder-node\u003e markup that you can use in an html section's html"}},"required":["embed_html"]}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns a \u003cbuilder-node\u003e custom element markup string that you can paste into the html of an html_section to embed a structured builder node (e.g. an order form, input field, button, signup form, etc.) inside free-form HTML.\n\nHow to use:\n  1. Use the node_types endpoints for this builder role to find the `type` of the node you want to embed and its available settings.\n  2. POST here with that `type` and any `settings` you want baked in. The response contains `embed_html` — a self-contained \u003cbuilder-node ...\u003e\u003c/builder-node\u003e snippet.\n  3. Paste that `embed_html` string verbatim into the `html` you send to the html_section update endpoint (POST builder/content/html_section). At runtime it will be replaced with the rendered node.\n\nTypical flow: build the bulk of your page as HTML via the html_section update endpoint, and sprinkle in these \u003cbuilder-node\u003e embeds wherever you need a dynamic Simplero element (order form, opt-in form, buy button, etc.) that you can't express as plain HTML.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Setting values keyed by setting id. All settings/breakpoints/args are optional."}},"required":["type"]}}}}}},"/api/v2/pages/{id}/builder/content/html_section":{"post":{"summary":"Create or update HTML section content","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"node_id":{"type":"string","description":"The id of the html_section node."},"name":{"type":"string","nullable":true,"description":"User-assigned name of this node, if set."},"html":{"type":"string","description":"The full HTML content of the section."}},"required":["node_id","html"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Create or update the HTML content of an html_section node.\n\n`node_id` is required. Pass either:\n  * The id of an existing `html_section` node — updates its HTML.\n  * The literal string `\"create_new\"` — creates a new `html_section` node under the root with the given `html`.\n\nPass `publish_changes: true` to publish the working version immediately after the change.\n\nEmbedding structured builder nodes inside the HTML:\n  You can embed dynamic Simplero elements (order forms, opt-in forms, buttons, input fields, etc.) inside the HTML. See the description of the html_section embed endpoint (POST builder/content/html_section/embed) for how this works.\n","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"html":{"type":"string","description":"The HTML content to set. CSS rules MUST be wrapped in \u003cstyle\u003e tags — the system extracts them into a separate style field automatically. Never write bare CSS (e.g. `:root { }`, `.class { }`) as plain text in the body; it will be treated as visible text content, not styles. Inline style=\"\" attributes on elements are fine."},"node_id":{"type":"string","description":"The id of the html_section node to update, or \"create_new\" to create a new one."},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node instance. Optional; omit to preserve the current value (or leave unnamed when creating a new section)."},"publish_changes":{"type":"boolean","description":"Publish the working version after the change."}},"required":["html","node_id"]}}}}},"get":{"summary":"Get HTML section content","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","description":"The id of the html_section node."},"name":{"type":"string","nullable":true,"description":"User-assigned name of this node, if set."},"html":{"type":"string","description":"The full HTML content of the section."}},"required":["id","html"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Returns the HTML content of the html_section node with the given id.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}},{"name":"node_id","in":"query","required":true,"schema":{"type":"string","description":"The id of the html_section node to fetch."},"description":"The id of the html_section node to fetch."}]}},"/api/v2/pages/{id}/builder/content/publish":{"post":{"summary":"Publish the working version","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"}},"required":["success"]}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"description":"Publishes the current working version of this record's builder doc, making staged changes live.","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/pages/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/pages/{id}/actions/publish":{"post":{"summary":"Publish","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/unpublish":{"post":{"summary":"Unpublish","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/drip":{"post":{"summary":"Drip","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/add_to_main_nav":{"post":{"summary":"Add to main nav","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/clone_to_site":{"post":{"summary":"Clone to another site","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/pages/{id}/actions/move_to_site":{"post":{"summary":"Move to another site","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"site_id":{"type":"integer","description":"Site"}}}}}}}},"/api/v2/pages/{id}/actions/move_to_funnel":{"post":{"summary":"Move to funnel","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"funnel_id":{"type":"integer","description":"Funnel"}}}}}}}},"/api/v2/pages/{id}/actions/convert_to_landing_page":{"post":{"summary":"Turn into a Landing Page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/undo_move":{"post":{"summary":"Undo move to site page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/create_funnel_from":{"post":{"summary":"Turn into a Funnel","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/reset_view_counters":{"post":{"summary":"Reset view counters","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/hide_from_bots":{"post":{"summary":"Hide from robots and search engines","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/unhide_from_bots":{"post":{"summary":"Unhide from robots and search engines","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/toggle_bots":{"post":{"summary":"Toggle bot visibility","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/hide_from_site_search":{"post":{"summary":"Hide from site search","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/unhide_from_site_search":{"post":{"summary":"Include in site search","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/toggle_site_search":{"post":{"summary":"Toggle site search visibility","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/hide_from_ai_bots":{"post":{"summary":"Hide from AI bots","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/unhide_from_ai_bots":{"post":{"summary":"Unhide from AI bots","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/toggle_ai_bots":{"post":{"summary":"Toggle AI bot visibility","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/make_home_page":{"post":{"summary":"Make this page the site home page","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/replace_with_redirect":{"post":{"summary":"Replace with redirect","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"redirect_to":{"type":"string"},"redirect_to_raw":{"type":"string"},"permanent":{"type":"string"}}}}}}}},"/api/v2/pages/{id}/actions/save_as_template":{"post":{"summary":"Save as template","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/convert_to_builder_v2":{"post":{"summary":"Convert to Page Builder 2.0","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/refresh_page_speed_score":{"post":{"summary":"Refresh page speed score","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pages/{id}/actions/start_split_testing":{"post":{"summary":"Start split test","tags":["Pages"],"x-simplero-resource-type":"pages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pipeline_stages":{"get":{"summary":"List pipeline stages","tags":["Pipeline Stages"],"x-simplero-resource-type":"pipeline_stages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PipelineStage"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"pipeline_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a pipeline stage","tags":["Pipeline Stages"],"x-simplero-resource-type":"pipeline_stages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PipelineStage"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStage"}}}}}},"/api/v2/pipeline_stages/{id}":{"get":{"summary":"Get a pipeline stage","tags":["Pipeline Stages"],"x-simplero-resource-type":"pipeline_stages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PipelineStage"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a pipeline stage","tags":["Pipeline Stages"],"x-simplero-resource-type":"pipeline_stages","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PipelineStage"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageOptional"}}}}}},"/api/v2/pipelines":{"get":{"summary":"List pipelines","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Pipeline"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"entry_type","in":"query","required":false,"schema":{"type":"string","enum":[0,1,2]}}]},"post":{"summary":"Create a pipeline","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Pipeline"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Pipeline"}}}}}},"/api/v2/pipelines/{id}":{"get":{"summary":"Get a pipeline","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Pipeline"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a pipeline","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Pipeline"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineOptional"}}}}}},"/api/v2/pipelines/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/pipelines/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/pipelines/{id}/actions/star":{"post":{"summary":"Star","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pipelines/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/pipelines/{id}/actions/set_default":{"post":{"summary":"Set default","tags":["Pipelines"],"x-simplero-resource-type":"pipelines","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/price_periods":{"get":{"summary":"List price periods","tags":["Price Periods"],"x-simplero-resource-type":"price_periods","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/PricePeriod"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"price_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a price period","tags":["Price Periods"],"x-simplero-resource-type":"price_periods","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricePeriod"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricePeriod"}}}}}},"/api/v2/price_periods/{id}":{"get":{"summary":"Get a price period","tags":["Price Periods"],"x-simplero-resource-type":"price_periods","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricePeriod"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a price period","tags":["Price Periods"],"x-simplero-resource-type":"price_periods","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/PricePeriod"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PricePeriodOptional"}}}}}},"/api/v2/prices":{"get":{"summary":"List prices","tags":["Prices"],"x-simplero-resource-type":"prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Price"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"listing_type","in":"query","required":false,"schema":{"type":"string","enum":["published","secret","coupon"]}},{"name":"price_type","in":"query","required":false,"schema":{"type":"string","enum":["purchase","subscription"]}},{"name":"currency_type","in":"query","required":false,"schema":{"type":"string","enum":["money","credit"]}},{"name":"enabled","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"product_variant_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a price","tags":["Prices"],"x-simplero-resource-type":"prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Price"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Price"}}}}}},"/api/v2/prices/{id}":{"get":{"summary":"Get a price","tags":["Prices"],"x-simplero-resource-type":"prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Price"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a price","tags":["Prices"],"x-simplero-resource-type":"prices","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Price"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceOptional"}}}}}},"/api/v2/product_variants":{"get":{"summary":"List variants","tags":["Product Variants"],"x-simplero-resource-type":"product_variants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a variant","tags":["Product Variants"],"x-simplero-resource-type":"product_variants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductVariant"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariant"}}}}}},"/api/v2/product_variants/{id}":{"get":{"summary":"Get a variant","tags":["Product Variants"],"x-simplero-resource-type":"product_variants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductVariant"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a variant","tags":["Product Variants"],"x-simplero-resource-type":"product_variants","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/ProductVariant"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductVariantOptional"}}}}}},"/api/v2/products":{"get":{"summary":"List products","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Product"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"facet_value_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"listing_type","in":"query","required":false,"schema":{"type":"string"}},{"name":"site_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"recurring","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]},"post":{"summary":"Create a product","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Product"}}}}}},"/api/v2/products/{id}":{"get":{"summary":"Get a product","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a product","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Product"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductOptional"}}}}}},"/api/v2/products/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/add_facet_values":{"post":{"summary":"Add facet values","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/products/{id}/actions/remove_facet_values":{"post":{"summary":"Remove facet values","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/products/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/products/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/products/{id}/actions/star":{"post":{"summary":"Star","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/list":{"post":{"summary":"List","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/unlist":{"post":{"summary":"Unlist","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/close":{"post":{"summary":"Close","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/products/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Products"],"x-simplero-resource-type":"products","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases":{"get":{"summary":"List purchases","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Purchase"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"product_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"price_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"price_period_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"payment_processor_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"parent_purchase_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"affiliate_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sales_rep_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"landing_page_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"funnel_step_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"coupon_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"tax_region_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"country_code","in":"query","required":false,"schema":{"type":"string"}},{"name":"vat_no","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"offer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"mailing_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"purchased_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"committed_until","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"discount_expires_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"renewed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"period_ends_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"canceled_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"refunded_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"first_failed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"next_attempt_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"marked_failed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"incoming","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"subscription","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"taxes_collected","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"received_price_cents","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"tag_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"utm_campaign","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"preventing_account_pausing","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]}},"/api/v2/purchases/{id}":{"get":{"summary":"Get a purchase","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Purchase"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/update_next_charge_on":{"post":{"summary":"Update next charge on","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"next_charge_on":{"type":"string","format":"date-time"}}}}}}}},"/api/v2/purchases/{id}/actions/postpone_upcoming_charges_by":{"post":{"summary":"Postpone upcoming charges by","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"postpone_upcoming_charges_by":{"type":"integer"}}}}}}}},"/api/v2/purchases/{id}/actions/update_period_ends_at":{"post":{"summary":"Update period ends at","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"period_ends_on":{"type":"string","format":"date-time"}}}}}}}},"/api/v2/purchases/{id}/actions/postpone_period_ends_at_by":{"post":{"summary":"Postpone period ends at by","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"postpone_period_ends_at_by":{"type":"integer"}}}}}}}},"/api/v2/purchases/{id}/actions/refund":{"post":{"summary":"Refund","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/cancel":{"post":{"summary":"Cancel","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/capture":{"post":{"summary":"Capture","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/pause":{"post":{"summary":"Pause","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/resume":{"post":{"summary":"Resume","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/move_to_product":{"post":{"summary":"Move to another product","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"product_id":{"type":"integer","description":"Product"},"fire_triggers":{"type":"boolean"}}}}}}}},"/api/v2/purchases/{id}/actions/change_price":{"post":{"summary":"Change price","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"period_id":{"type":"integer","description":"Period"}}}}}}}},"/api/v2/purchases/{id}/actions/change_tax_percent":{"post":{"summary":"Change tax percent","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"tax_percent":{"type":"number"}}}}}}}},"/api/v2/purchases/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/purchases/{id}/actions/set_auto_responder_start_at":{"post":{"summary":"Set auto responder start at","tags":["Purchases"],"x-simplero-resource-type":"purchases","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_at":{"type":"string","format":"date-time"}}}}}}}},"/api/v2/scheduling_links":{"get":{"summary":"List scheduling links","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SchedulingLink"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"owner_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"type","in":"query","required":false,"schema":{"type":"string","enum":["individual","round_robin","collective"]}}]},"post":{"summary":"Create a scheduling link","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SchedulingLink"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingLink"}}}}}},"/api/v2/scheduling_links/{id}":{"get":{"summary":"Get a scheduling link","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SchedulingLink"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a scheduling link","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SchedulingLink"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SchedulingLinkOptional"}}}}}},"/api/v2/scheduling_links/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/scheduling_links/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/scheduling_links/{id}/actions/star":{"post":{"summary":"Star","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/scheduling_links/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/scheduling_links/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Scheduling Links"],"x-simplero-resource-type":"scheduling_links","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments":{"get":{"summary":"List segments","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Segment"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"saved","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/segments/{id}":{"get":{"summary":"Get a segment","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Segment"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/segments/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/segments/{id}/actions/star":{"post":{"summary":"Star","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments/{id}/actions/refresh":{"post":{"summary":"Refresh","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/segments/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Segments"],"x-simplero-resource-type":"segments","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites":{"get":{"summary":"List sites","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Site"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"access","in":"query","required":false,"schema":{"type":"string","enum":["public","private"]}},{"name":"enabled","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"title","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true}]},"post":{"summary":"Create a site","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Site"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Site"}}}}}},"/api/v2/sites/{id}":{"get":{"summary":"Get a site","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Site"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a site","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Site"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteOptional"}}}}}},"/api/v2/sites/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/sites/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/sites/{id}/actions/star":{"post":{"summary":"Star","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/reindex":{"post":{"summary":"Reindex","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/enable_chat_bot":{"post":{"summary":"Enable AI search and interactions","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/disable_chat_bot":{"post":{"summary":"Disable AI search and interactions","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/sites/{id}/actions/grant_access":{"post":{"summary":"Add member","tags":["Sites"],"x-simplero-resource-type":"sites","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"integer","description":"Customer"},"send_login_email":{"type":"boolean"}}}}}}}},"/api/v2/steps":{"get":{"summary":"List automation steps","tags":["Steps"],"x-simplero-resource-type":"steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Step"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"automation_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a automation step","tags":["Steps"],"x-simplero-resource-type":"steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Step"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Step"}}}}}},"/api/v2/steps/{id}":{"get":{"summary":"Get a automation step","tags":["Steps"],"x-simplero-resource-type":"steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Step"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a automation step","tags":["Steps"],"x-simplero-resource-type":"steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Step"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StepOptional"}}}}}},"/api/v2/steps/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Steps"],"x-simplero-resource-type":"steps","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions":{"get":{"summary":"List list subscriptions","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"landing_page_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"affiliate_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"first_activated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"unsubscribed_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"first_names","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"last_name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"email","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"unengaged_between","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"tag_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"do_not_contact","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"utm_campaign","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_campaign_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_campaign_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_content_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_medium_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_source_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_term_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_adgroup_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_first","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"utm_keyword_last","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"lifetime_value_cents_excl_tax","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"list_id","in":"query","required":false,"schema":{"type":"string"}}]}},"/api/v2/subscriptions/{id}":{"get":{"summary":"Get a list subscription","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Subscription"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/unsubscribe":{"post":{"summary":"Unsubscribe","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/request_confirmation":{"post":{"summary":"Resend email asking for confirmation","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/suspend":{"post":{"summary":"Suspend","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/resume":{"post":{"summary":"Resume","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/force_activate":{"post":{"summary":"Force activate","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/resubscribe":{"post":{"summary":"Resubscribe","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/resend_welcome":{"post":{"summary":"Resend welcome email","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/set_auto_responder_start_at":{"post":{"summary":"Set auto responder start at","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"start_at":{"type":"string","format":"date-time"}}}}}}}},"/api/v2/subscriptions/{id}/actions/set_affiliate":{"post":{"summary":"Set Affiilate for List Subscriber","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"affiliate_id":{"type":"integer","description":"Affiliate"}}}}}}}},"/api/v2/subscriptions/{id}/actions/remove_affiliate":{"post":{"summary":"Remove Affiliate for List Subscriber","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/subscriptions/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Subscriptions"],"x-simplero-resource-type":"subscriptions","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/survey_responses":{"get":{"summary":"List survey responses","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/SurveyResponse"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"customer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"funnel_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"funnel_step_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"is_bad_name","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"spam","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"survey_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a survey response","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"/api/v2/survey_responses/{id}":{"get":{"summary":"Get a survey response","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a survey response","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/SurveyResponse"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyResponseOptional"}}}}}},"/api/v2/survey_responses/{id}/actions/post_to_conversation":{"post":{"summary":"Post message to conversation","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"},"message":{"type":"string"}}}}}}}},"/api/v2/survey_responses/{id}/actions/add_to_conversation":{"post":{"summary":"Add to conversation","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"}}}}}}}},"/api/v2/survey_responses/{id}/actions/associate_contact":{"post":{"summary":"Associate with Contact","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"customer_id":{"type":"integer","description":"Customer"}}}}}}}},"/api/v2/survey_responses/{id}/actions/disassociate_from_funnel":{"post":{"summary":"Disassociate from funnel","tags":["Survey Responses"],"x-simplero-resource-type":"survey_responses","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/surveys":{"get":{"summary":"List surveys","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Survey"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"active","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}}]},"post":{"summary":"Create a survey","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Survey"}}}}}},"/api/v2/surveys/{id}":{"get":{"summary":"Get a survey","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a survey","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Survey"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SurveyOptional"}}}}}},"/api/v2/surveys/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/surveys/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/surveys/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/surveys/{id}/actions/star":{"post":{"summary":"Star","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/surveys/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/surveys/{id}/actions/duplicate":{"post":{"summary":"Duplicate","tags":["Surveys"],"x-simplero-resource-type":"surveys","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/taggings":{"get":{"summary":"List taggings","tags":["Taggings"],"x-simplero-resource-type":"taggings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tagging"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"tag_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"}}]},"post":{"summary":"Create a tagging","tags":["Taggings"],"x-simplero-resource-type":"taggings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tagging"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tagging"}}}}}},"/api/v2/taggings/{id}":{"get":{"summary":"Get a tagging","tags":["Taggings"],"x-simplero-resource-type":"taggings","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tagging"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tags":{"get":{"summary":"List tags","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Tag"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"shown_in_admin","in":"query","required":false,"schema":{"type":"string","enum":["starred","unstarred","all"]}},{"name":"owner_id","in":"query","required":false,"schema":{"type":"integer"}}]},"post":{"summary":"Create a tag","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tag"}}}}}},"/api/v2/tags/{id}":{"get":{"summary":"Get a tag","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a tag","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Tag"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TagOptional"}}}}}},"/api/v2/tags/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/tags/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/tags/{id}/actions/star":{"post":{"summary":"Star","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tags/{id}/actions/unstar":{"post":{"summary":"Unstar","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tags/{id}/actions/rename":{"post":{"summary":"Rename","tags":["Tags"],"x-simplero-resource-type":"tags","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string"}}}}}}}},"/api/v2/testimonials":{"get":{"summary":"List testimonials","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Testimonial"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"label_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"published","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"rating","in":"query","required":false,"schema":{"$ref":"#/components/schemas/NumericFilter"},"style":"deepObject","explode":true},{"name":"author_name","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"author_email","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"customer_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"product_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"bot_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"with_attachment","in":"query","required":false,"schema":{"type":"string","enum":["with_video","with_audio","with_image","with_any_attachment"]}},{"name":"permission_given_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"permission_given","in":"query","required":false,"schema":{"type":"string","enum":["1","0"]}},{"name":"aspect_ratio","in":"query","required":false,"schema":{"type":"string","enum":["ratio_16_9","ratio_9_16","ratio_4_5","ratio_5_4","ratio_4_3","ratio_3_4","square","portrait","landscape"]}}]},"post":{"summary":"Create a testimonial","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Testimonial"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Testimonial"}}}}}},"/api/v2/testimonials/{id}":{"get":{"summary":"Get a testimonial","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Testimonial"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a testimonial","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Testimonial"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestimonialOptional"}}}}}},"/api/v2/testimonials/{id}/actions/add_labels":{"post":{"summary":"Add labels","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/testimonials/{id}/actions/remove_label":{"post":{"summary":"Remove label","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"},"description":"Label"}}}}}}}},"/api/v2/testimonials/{id}/actions/publish":{"post":{"summary":"Publish","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/testimonials/{id}/actions/unpublish":{"post":{"summary":"Unpublish","tags":["Testimonials"],"x-simplero-resource-type":"testimonials","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets":{"get":{"summary":"List tickets","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Ticket"}},"pagination":{"type":"object","properties":{"page":{"type":"integer","description":"Current page number"},"per_page":{"type":"integer","description":"Results per page"},"total":{"type":"integer","description":"Total number of records"},"total_pages":{"type":"integer","description":"Total number of pages"}}}}}}}},"401":{"description":"Unauthorized"}},"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","description":"Page number (default 1)"},"description":"Page number (default 1)"},{"name":"per_page","in":"query","required":false,"schema":{"type":"integer","description":"Results per page (1–100, default 20)"},"description":"Results per page (1–100, default 20)"},{"name":"created_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"updated_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"facet_value_id","in":"query","required":false,"schema":{"type":"object","properties":{"value":{"type":"integer"},"operator":{"type":"string","enum":["any","all"]}}},"style":"deepObject","explode":true},{"name":"pipeline_stage_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"status","in":"query","required":false,"schema":{"type":"string","enum":["open","waiting","closed"]}},{"name":"customer_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"last_comment_at","in":"query","required":false,"schema":{"$ref":"#/components/schemas/DateFilter"},"style":"deepObject","explode":true},{"name":"track","in":"query","required":false,"schema":{"$ref":"#/components/schemas/StringFilter"},"style":"deepObject","explode":true},{"name":"assignee_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"comment_poster_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"submitter_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"submitting_account_id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"signup_offer","in":"query","required":false,"schema":{"type":"string"}},{"name":"rating","in":"query","required":false,"schema":{"type":"string"}},{"name":"has_nps_score","in":"query","required":false,"schema":{"type":"string","enum":[1]}},{"name":"product_id","in":"query","required":false,"schema":{"type":"string"}},{"name":"lead_status","in":"query","required":false,"schema":{"type":"string","enum":["customers","leads"]}}]},"post":{"summary":"Create a ticket","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Ticket"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"401":{"description":"Unauthorized"}},"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Ticket"}}}}}},"/api/v2/tickets/{id}":{"get":{"summary":"Get a ticket","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Ticket"}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]},"patch":{"summary":"Update a ticket","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/Ticket"}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketOptional"}}}}}},"/api/v2/tickets/{id}/actions/resurrect":{"post":{"summary":"Resurrect","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/add_facet_values":{"post":{"summary":"Add facet values","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/tickets/{id}/actions/remove_facet_values":{"post":{"summary":"Remove facet values","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"},"description":"FacetValue"}}}}}}}},"/api/v2/tickets/{id}/actions/move_to_stage":{"post":{"summary":"Move to pipeline stage","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/tickets/{id}/actions/move_to_pipeline":{"post":{"summary":"Move to pipeline","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"pipeline_stage_id":{"type":"integer","description":"PipelineStage"}}}}}}}},"/api/v2/tickets/{id}/actions/add_comment":{"post":{"summary":"Add comment","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"comment":{"type":"string"},"poster_id":{"type":"integer","description":"User"}}}}}}}},"/api/v2/tickets/{id}/actions/unlock":{"post":{"summary":"Unlock","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/mark_unread":{"post":{"summary":"Mark as unread by assignee","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/mark_read":{"post":{"summary":"Mark as read by assignee","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/assign_to_me":{"post":{"summary":"Assign to me","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/reassign":{"post":{"summary":"Reassign","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"user_id":{"type":"integer","description":"User"}}}}}}}},"/api/v2/tickets/{id}/actions/exclude_from_csat":{"post":{"summary":"Exclude from CSAT reporting","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}]}},"/api/v2/tickets/{id}/actions/remove_facet":{"post":{"summary":"Remove a facet","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_id":{"type":"integer","description":"FacetValue"}}}}}}}},"/api/v2/tickets/{id}/actions/add_facet":{"post":{"summary":"Add a facet","tags":["Tickets"],"x-simplero-resource-type":"tickets","responses":{"200":{"content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"success":{"type":"boolean"},"message":{"type":"string"}}}}}}}},"422":{"content":{"application/json":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"string"}}}}}}},"404":{"description":"Not found"},"401":{"description":"Unauthorized"}},"parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"integer"}}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"facet_value_id":{"type":"integer","description":"FacetValue"}}}}}}}}},"components":{"securitySchemes":{"apiKeyHeader":{"type":"apiKey","in":"header","name":"X-API-Key","description":"API key from Settings \u003e Integrations"}},"schemas":{"Action":{"type":"object","properties":{"relative_time_count":{"type":"integer"},"relative_time_unit":{"type":"string"},"action":{"type":"string","description":"Action identifier in the form '\u003cModel\u003e-\u003caction_name\u003e', e.g. 'Customer-library_mailing'."},"args":{"type":"object","description":"Arguments for the action. The exact shape depends on `action` — e.g. `Customer-library_mailing` takes `{ mailing_id }`."},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["action","created_at","updated_at"]},"ActionOptional":{"type":"object","properties":{"relative_time_count":{"type":"integer"},"relative_time_unit":{"type":"string"},"action":{"type":"string","description":"Action identifier in the form '\u003cModel\u003e-\u003caction_name\u003e', e.g. 'Customer-library_mailing'."},"args":{"type":"object","description":"Arguments for the action. The exact shape depends on `action` — e.g. `Customer-library_mailing` takes `{ mailing_id }`."}}},"AdminRole":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string"},"system_key":{"type":"string"}}},"Administratorship":{"type":"object","properties":{"user":{"$ref":"#/components/schemas/User","readOnly":true},"user_id":{"type":"integer"},"admin_role":{"$ref":"#/components/schemas/AdminRole"},"admin_role_id":{"type":"integer"},"invitation":{"$ref":"#/components/schemas/Invitation"},"invitation_id":{"type":"integer"},"enabled":{"type":"boolean"},"ticket_assignee":{"type":"boolean"},"ticket_sms_alerts":{"type":"boolean"},"show_on_ticket":{"type":"boolean"},"can_self_grant_super_admin":{"type":"boolean"},"num_logins":{"type":"integer","readOnly":true},"last_login_at":{"type":"string","format":"date-time","readOnly":true},"second_to_last_login_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["admin_role_id"]},"Affiliate":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}},"recurring_charge_duration_count":{"type":"integer"},"recurring_charge_duration_unit":{"type":"string"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/User","readOnly":true},"upstream_affiliate":{"$ref":"#/components/schemas/Affiliate","readOnly":true},"upstream_affiliate_id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"handle":{"type":"string"},"list_size":{"type":"integer"},"paypal_email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"tax_id":{"type":"string"},"company_name":{"type":"string"},"affiliate_program":{"$ref":"#/components/schemas/AffiliateProgram","readOnly":true},"affiliate_program_id":{"type":"integer"},"first_names":{"type":"string"},"last_name":{"type":"string"},"country_code":{"type":"string"},"coupon_code":{"type":"string"},"state":{"type":"string"},"commission_type":{"type":"string","enum":["inherit","percentage","fixed"]},"percentage":{"type":"integer"},"fixed_amount":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","affiliate_program_id","first_names","last_name","country_code"]},"AffiliateLink":{"type":"object","properties":{"token":{"type":"string","readOnly":true}},"required":["token"]},"AffiliateOptional":{"type":"object","properties":{"field_value_ids":{"type":"array","items":{"type":"integer"}},"recurring_charge_duration_count":{"type":"integer"},"recurring_charge_duration_unit":{"type":"string"},"customer_id":{"type":"integer"},"upstream_affiliate_id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"handle":{"type":"string"},"list_size":{"type":"integer"},"paypal_email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"tax_id":{"type":"string"},"company_name":{"type":"string"},"first_names":{"type":"string"},"last_name":{"type":"string"},"country_code":{"type":"string"},"coupon_code":{"type":"string"},"state":{"type":"string"},"commission_type":{"type":"string","enum":["inherit","percentage","fixed"]},"percentage":{"type":"integer"},"fixed_amount":{"type":"integer"}}},"AffiliateProgram":{"type":"object","properties":{"recurring_charge_duration_count":{"type":"integer"},"recurring_charge_duration_unit":{"type":"string"},"server_side_expiration_count":{"type":"integer"},"server_side_expiration_unit":{"type":"string"},"cookie_expiration_count":{"type":"integer"},"cookie_expiration_unit":{"type":"string"},"token":{"type":"string","readOnly":true},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"commission_type":{"type":"string","enum":["percentage","fixed"]},"percentage":{"type":"integer"},"fixed_amount":{"type":"integer"},"tiered":{"type":"boolean"},"upstream_percentage":{"type":"integer"},"upstream_paid_by_affiliate":{"type":"boolean"},"payout_schedule":{"type":"string","enum":["manual","first_of_month","last_of_month","second_last_of_month","specific_day"]},"payout_method":{"type":"string","enum":["paypal_masspay","paypal_payouts","manual"]},"payout_day":{"type":"integer"},"minimum_payout_cents":{"type":"integer"},"require_approval":{"type":"boolean"},"require_documentation":{"type":"boolean"},"require_paypal_email":{"type":"boolean"},"allow_self_purchase":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"send_login_email":{"type":"boolean"},"affiliates_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name"]},"AffiliateProgramOptional":{"type":"object","properties":{"recurring_charge_duration_count":{"type":"integer"},"recurring_charge_duration_unit":{"type":"string"},"server_side_expiration_count":{"type":"integer"},"server_side_expiration_unit":{"type":"string"},"cookie_expiration_count":{"type":"integer"},"cookie_expiration_unit":{"type":"string"},"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"commission_type":{"type":"string","enum":["percentage","fixed"]},"percentage":{"type":"integer"},"fixed_amount":{"type":"integer"},"tiered":{"type":"boolean"},"upstream_percentage":{"type":"integer"},"upstream_paid_by_affiliate":{"type":"boolean"},"payout_schedule":{"type":"string","enum":["manual","first_of_month","last_of_month","second_last_of_month","specific_day"]},"payout_method":{"type":"string","enum":["paypal_masspay","paypal_payouts","manual"]},"payout_day":{"type":"integer"},"minimum_payout_cents":{"type":"integer"},"require_approval":{"type":"boolean"},"require_documentation":{"type":"boolean"},"require_paypal_email":{"type":"boolean"},"allow_self_purchase":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"send_login_email":{"type":"boolean"}}},"AlternativePrice":{"type":"object","properties":{"priceable":{"type":"object","readOnly":true},"priceable_id":{"type":"integer"},"priceable_type":{"type":"string"},"currency_code":{"type":"string"},"price_cents":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["priceable_id","priceable_type","currency_code","price_cents","created_at","updated_at"]},"AlternativePriceOptional":{"type":"object","properties":{"currency_code":{"type":"string"},"price_cents":{"type":"integer"}}},"Asset":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"filename":{"type":"string","readOnly":true},"content_type":{"type":"string","readOnly":true},"size":{"type":"integer","readOnly":true},"duration_seconds":{"type":"integer","readOnly":true},"width":{"type":"integer","readOnly":true},"height":{"type":"integer","readOnly":true},"media_type":{"type":"string","readOnly":true},"url":{"type":"string","readOnly":true},"transcript":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"Attachment":{"type":"object","properties":{"title":{"type":"string"},"position":{"type":"integer"},"asset":{"$ref":"#/components/schemas/Asset","readOnly":true},"asset_id":{"type":"integer"},"media_type":{"type":"string","readOnly":true},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"view_embedded":{"type":"boolean"}}},"AutoResponse":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"body_editor":{"type":"string"},"subject":{"type":"string"},"preheader":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"template":{"$ref":"#/components/schemas/EmailTemplate","readOnly":true},"email_template_id":{"type":"integer"},"recipients_segment":{"$ref":"#/components/schemas/Segment","readOnly":true},"recipients_segment_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/User","readOnly":true},"user_id":{"type":"integer"},"hide_from_archive":{"type":"boolean"},"hide_web_version":{"type":"boolean"},"hide_from_recents":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"non_warming":{"type":"boolean"},"split_test":{"type":"boolean"},"subject_b":{"type":"string"},"preheader_b":{"type":"string"},"test_percentage":{"type":"integer"},"test_duration_minutes":{"type":"integer"},"state":{"type":"string","readOnly":true},"recipients_count":{"type":"integer","readOnly":true},"subject_a_open_rate":{"type":"number","readOnly":true},"subject_b_open_rate":{"type":"number","readOnly":true},"spam_score":{"type":"number","readOnly":true},"spam_hits":{"type":"string","readOnly":true},"for_single_action":{"type":"boolean","readOnly":true},"deliveries_finalized":{"type":"boolean","readOnly":true},"delivered_at":{"type":"string","format":"date-time","readOnly":true},"deliver_at":{"type":"string","format":"date-time","readOnly":true},"queued_at":{"type":"string","format":"date-time","readOnly":true},"body_updated_at":{"type":"string","format":"date-time","readOnly":true},"start_delivering_at":{"type":"string","format":"date-time","readOnly":true},"first_delivery_at":{"type":"string","format":"date-time","readOnly":true},"last_delivery_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["email_template_id"]},"Automation":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"name":{"type":"string"},"active":{"type":"boolean"},"on_hold":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"reenter":{"type":"boolean"},"allow_duplicate_active_contact":{"type":"boolean"},"force_customer":{"type":"boolean"},"always_run":{"type":"boolean"},"object_type":{"type":"string","description":"Type of recipient this automation runs on. Blank means flexible (any contact-like object). Examples: 'Customer', 'Purchase', 'Entrant', 'Subscription', 'EventOccurrenceParticipant'."},"manage_mode":{"type":"integer"},"notes":{"type":"string"},"start_confirmation_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"start_confirmation_page_id":{"type":"integer"},"stop_confirmation_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"stop_confirmation_page_id":{"type":"integer"},"pause_confirmation_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"pause_confirmation_page_id":{"type":"integer"},"resume_confirmation_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"resume_confirmation_page_id":{"type":"integer"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/Step"},"readOnly":true},"step_ids":{"type":"array","items":{"type":"integer"}},"starter_products":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"readOnly":true},"starter_product_ids":{"type":"array","items":{"type":"integer"}},"starter_lists":{"type":"array","items":{"$ref":"#/components/schemas/List"},"readOnly":true},"starter_list_ids":{"type":"array","items":{"type":"integer"}},"flows_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","created_at","updated_at"]},"AutomationOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"active":{"type":"boolean"},"on_hold":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"reenter":{"type":"boolean"},"allow_duplicate_active_contact":{"type":"boolean"},"force_customer":{"type":"boolean"},"always_run":{"type":"boolean"},"object_type":{"type":"string","description":"Type of recipient this automation runs on. Blank means flexible (any contact-like object). Examples: 'Customer', 'Purchase', 'Entrant', 'Subscription', 'EventOccurrenceParticipant'."},"manage_mode":{"type":"integer"},"notes":{"type":"string"},"start_confirmation_page_id":{"type":"integer"},"stop_confirmation_page_id":{"type":"integer"},"pause_confirmation_page_id":{"type":"integer"},"resume_confirmation_page_id":{"type":"integer"},"step_ids":{"type":"array","items":{"type":"integer"}},"starter_product_ids":{"type":"array","items":{"type":"integer"}},"starter_list_ids":{"type":"array","items":{"type":"integer"}}}},"Availability":{"type":"object","properties":{"owner":{"$ref":"#/components/schemas/Administratorship","readOnly":true},"owner_id":{"type":"integer"},"name":{"type":"string"},"preset":{"type":"boolean"},"recurring_ranges":{"type":"array","items":{"type":"object","properties":{"days":{"type":"array","items":{"type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]}},"starts_at":{"type":"string","description":"Start time in 12h format, e.g. '09:00 AM'"},"ends_at":{"type":"string","description":"End time in 12h format, e.g. '05:00 PM'"}},"required":["days","starts_at","ends_at"]},"description":"Weekly recurring availability windows. Each entry defines one or more days-of-week with a start/end time."},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["owner","owner_id","created_at","updated_at"]},"AvailabilityOptional":{"type":"object","properties":{"name":{"type":"string"},"preset":{"type":"boolean"},"recurring_ranges":{"type":"array","items":{"type":"object","properties":{"days":{"type":"array","items":{"type":"string","enum":["Monday","Tuesday","Wednesday","Thursday","Friday","Saturday","Sunday"]}},"starts_at":{"type":"string","description":"Start time in 12h format, e.g. '09:00 AM'"},"ends_at":{"type":"string","description":"End time in 12h format, e.g. '05:00 PM'"}},"required":["days","starts_at","ends_at"]},"description":"Weekly recurring availability windows. Each entry defines one or more days-of-week with a start/end time."}}},"Bot":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"subtitle":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"}}},"BuilderDocNode":{"type":"object","properties":{"id":{"type":"string","description":"Unique node id, e.g. n_abc123"},"type":{"type":"string","description":"Node type identifier, e.g. section, row, column, elements/headline, elements/paragraph"},"name":{"type":"string","nullable":true,"description":"User-assigned name for this node. Null/absent if no custom name has been set. This is the stored value only — the type-derived display name is available via the `name` field on the node type from the node_types endpoint."},"settings":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/BuilderDocNodeSetting"},"description":"Setting id → setting value. Every setting is optional; omitted settings use component defaults."},"children":{"type":"array","items":{"$ref":"#/components/schemas/BuilderDocNode"},"description":"Child nodes, recursively."}},"required":["id","type"],"description":"A node in a BuilderDoc tree."},"BuilderDocNodeSetting":{"type":"object","properties":{"base":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Arg value — arbitrary JSON scalar, object, or array. Shape depends on the specific setting and arg."},"description":"Base breakpoint arg values. Optional. If not specified, uses the arg's default value."},"tab":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Arg value — arbitrary JSON scalar, object, or array. Shape depends on the specific setting and arg."},"description":"Tablet breakpoint arg values. Optional — each arg overrides the base value for this breakpoint and below only."},"mob":{"type":"object","additionalProperties":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"},{"type":"array","items":{"anyOf":[{"type":"string"},{"type":"number"},{"type":"boolean"},{"type":"object"}]}}],"nullable":true,"description":"Arg value — arbitrary JSON scalar, object, or array. Shape depends on the specific setting and arg."},"description":"Mobile breakpoint arg values. Optional — each arg overrides the base (or tablet) value for this breakpoint only."}},"description":"Setting values grouped by breakpoint. Every breakpoint is optional; omitted breakpoints inherit from base. Within a breakpoint, every arg is optional and independently overrides the previous breakpoint's value on a per-arg basis."},"Calendar":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}}}},"CountdownInstance":{"type":"object","properties":{"timer":{"$ref":"#/components/schemas/CountdownTimer","readOnly":true},"countdown_timer_id":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"source":{"type":"object","readOnly":true},"source_id":{"type":"integer"},"source_type":{"type":"string"},"starts_at":{"type":"string","format":"date-time","readOnly":true},"ends_at":{"type":"string","format":"date-time","readOnly":true},"canceled_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["customer_id","starts_at","ends_at","created_at","updated_at"]},"CountdownTimer":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"duration_count":{"type":"integer"},"duration_unit":{"type":"string"},"internal_name":{"type":"string"},"strategy":{"type":"string","enum":["manual","fixed","user_choice","product_purchased_at","product_activated_at","list_subscribed_at","coaching_client_created_at","podcast_subscribed_at"],"description":"Determines how the countdown's end time is calculated and which other fields apply:\n- manual: duration applies. Instance starts when created.\n- fixed: fixed_ends_at applies. All instances end at the same time.\n- user_choice: the user_choice fields (instant_label, just_in_time_interval, daily_times, weekly_days, weekly_times, user_choices_time_zone) apply. The user picks their end time from generated options.\n- all other strategies: duration applies and owner_id/owner_type must reference the related object (Product, List, etc.)."},"duration_sign":{"type":"integer","description":"Sign for the duration: 1 = after the source date, -1 = before. Only applies when duration_count/duration_unit apply (see strategy)."},"fixed_ends_at":{"type":"string","format":"date-time","description":"Exact end time for the countdown. Only applies when strategy is fixed."},"owner":{"type":"object","readOnly":true},"owner_id":{"type":"integer"},"owner_type":{"type":"string"},"instant_label":{"type":"string","description":"Only applies when strategy is user_choice. Label shown for the \"instant replay\" option. Example: \"Watch now\""},"just_in_time_interval":{"type":"integer","description":"Only applies when strategy is user_choice. Minutes interval for the just-in-time option. Example: 15"},"daily_times":{"type":"array","items":{"type":"string"},"description":"Only applies when strategy is user_choice. Daily recurring times in 24h HH:MM format. Example: [\"09:00\", \"15:30\"]"},"weekly_days":{"type":"array","items":{"type":"integer"},"description":"Only applies when strategy is user_choice. Days of the week the weekly option repeats, 0=Sunday through 6=Saturday. Example: [1, 3, 5]"},"weekly_times":{"type":"array","items":{"type":"string"},"description":"Only applies when strategy is user_choice. Weekly recurring times in 24h HH:MM format. Example: [\"10:00\", \"14:00\"]"},"user_choices_time_zone":{"type":"string","description":"Only applies when strategy is user_choice. Timezone source for generated options. \"account\" uses the account timezone; \"local\" uses the visitor's detected timezone."},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["internal_name","strategy","created_at","updated_at"]},"CountdownTimerOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"duration_count":{"type":"integer"},"duration_unit":{"type":"string"},"internal_name":{"type":"string"},"strategy":{"type":"string","enum":["manual","fixed","user_choice","product_purchased_at","product_activated_at","list_subscribed_at","coaching_client_created_at","podcast_subscribed_at"],"description":"Determines how the countdown's end time is calculated and which other fields apply:\n- manual: duration applies. Instance starts when created.\n- fixed: fixed_ends_at applies. All instances end at the same time.\n- user_choice: the user_choice fields (instant_label, just_in_time_interval, daily_times, weekly_days, weekly_times, user_choices_time_zone) apply. The user picks their end time from generated options.\n- all other strategies: duration applies and owner_id/owner_type must reference the related object (Product, List, etc.)."},"duration_sign":{"type":"integer","description":"Sign for the duration: 1 = after the source date, -1 = before. Only applies when duration_count/duration_unit apply (see strategy)."},"fixed_ends_at":{"type":"string","format":"date-time","description":"Exact end time for the countdown. Only applies when strategy is fixed."},"owner_id":{"type":"integer"},"owner_type":{"type":"string"},"instant_label":{"type":"string","description":"Only applies when strategy is user_choice. Label shown for the \"instant replay\" option. Example: \"Watch now\""},"just_in_time_interval":{"type":"integer","description":"Only applies when strategy is user_choice. Minutes interval for the just-in-time option. Example: 15"},"daily_times":{"type":"array","items":{"type":"string"},"description":"Only applies when strategy is user_choice. Daily recurring times in 24h HH:MM format. Example: [\"09:00\", \"15:30\"]"},"weekly_days":{"type":"array","items":{"type":"integer"},"description":"Only applies when strategy is user_choice. Days of the week the weekly option repeats, 0=Sunday through 6=Saturday. Example: [1, 3, 5]"},"weekly_times":{"type":"array","items":{"type":"string"},"description":"Only applies when strategy is user_choice. Weekly recurring times in 24h HH:MM format. Example: [\"10:00\", \"14:00\"]"},"user_choices_time_zone":{"type":"string","description":"Only applies when strategy is user_choice. Timezone source for generated options. \"account\" uses the account timezone; \"local\" uses the visitor's detected timezone."}}},"Coupon":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"coupon_code":{"type":"string"},"internal_name":{"type":"string"},"discount_type":{"type":"string","enum":["none","percent","cents"]},"discount_percent":{"type":"number"},"discount_cents":{"type":"integer"},"discount_on_renewal":{"type":"boolean"},"discount_on_installments":{"type":"boolean"},"auto_apply":{"type":"boolean"},"auto_apply_trigger_quantity":{"type":"integer"},"auto_apply_target":{"type":"string"},"available_from":{"type":"string","format":"date-time"},"available_to":{"type":"string","format":"date-time"},"quantity_remain":{"type":"integer"},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"readOnly":true},"product_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"CouponOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"coupon_code":{"type":"string"},"internal_name":{"type":"string"},"discount_type":{"type":"string","enum":["none","percent","cents"]},"discount_percent":{"type":"number"},"discount_cents":{"type":"integer"},"discount_on_renewal":{"type":"boolean"},"discount_on_installments":{"type":"boolean"},"auto_apply":{"type":"boolean"},"auto_apply_trigger_quantity":{"type":"integer"},"auto_apply_target":{"type":"string"},"available_from":{"type":"string","format":"date-time"},"available_to":{"type":"string","format":"date-time"},"quantity_remain":{"type":"integer"},"product_ids":{"type":"array","items":{"type":"integer"}}}},"Course":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string"},"publish_status":{"type":"string"},"publish_at":{"type":"string","format":"date-time"},"display_mode":{"type":"string"},"comments_mode":{"type":"string"},"completion_enabled":{"type":"boolean"},"require_completion":{"type":"boolean"},"access_restricted":{"type":"boolean"},"autoplay_enabled":{"type":"boolean"},"prevent_downloads":{"type":"boolean"},"podcast_enabled":{"type":"boolean"},"show_lesson_author":{"type":"boolean"},"show_lesson_updated_at":{"type":"boolean","readOnly":true},"hide_content_counts":{"type":"boolean"},"hide_content_duration":{"type":"boolean"},"allow_private_note":{"type":"boolean"},"add_lessons_to_top":{"type":"boolean"},"award_certificates":{"type":"boolean"},"exclude_from_new_content":{"type":"boolean"},"show_unauthorized":{"type":"string"},"unauthorized_btn_type":{"type":"integer"},"unauthorized_btn_label":{"type":"string"},"unauthorized_btn_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"unauthorized_message":{"type":"string"},"site":{"$ref":"#/components/schemas/Site","readOnly":true},"site_id":{"type":"integer"},"site_group":{"$ref":"#/components/schemas/SiteGroup","readOnly":true},"site_group_id":{"type":"integer"},"catalog_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"catalog_image_id":{"type":"integer"},"app_card_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"app_card_image_id":{"type":"integer"},"description_background_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"description_background_image_id":{"type":"integer"},"default_lesson_thumbnail":{"$ref":"#/components/schemas/Asset","readOnly":true},"default_lesson_thumbnail_id":{"type":"integer"},"unauthorized_btn_product":{"$ref":"#/components/schemas/Product","readOnly":true},"unauthorized_btn_product_id":{"type":"integer"},"modules":{"type":"array","items":{"$ref":"#/components/schemas/CourseModule"},"readOnly":true},"module_ids":{"type":"array","items":{"type":"integer"}},"lessons":{"type":"array","items":{"$ref":"#/components/schemas/CourseLesson"},"readOnly":true},"products":{"type":"array","items":{"$ref":"#/components/schemas/Product"},"readOnly":true},"product_ids":{"type":"array","items":{"type":"integer"}}},"required":["created_at","updated_at","title","internal_name","site_id"]},"CourseLesson":{"type":"object","properties":{"title":{"type":"string"},"type":{"type":"string","description":"The kind of lesson. Must be one of:\n  - `CourseLesson::Content` — standard lesson with body, video, audio, attachments, etc.\n  - `CourseLesson::Quiz` — a quiz made up of questions the student answers.\n  - `CourseLesson::Worksheet` — a downloadable worksheet the student fills out.\n  - `CourseLesson::Survey` — a survey the student completes.\nCannot be changed once the lesson is created."},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string"},"publish_status":{"type":"string"},"date":{"type":"string","format":"date-time"},"publish_at":{"type":"string","format":"date-time"},"body_media_type":{"type":"string"},"media_duration_seconds":{"type":"integer"},"comments_count":{"type":"integer","readOnly":true},"total_views":{"type":"integer"},"expand_additional_content":{"type":"boolean"},"hide_additional_content_toggles":{"type":"boolean"},"show_unauthorized_course":{"type":"string","enum":["show","hide","overview"]},"show_unauthorized_lesson":{"type":"string","enum":["overview","hide","content"]},"unauthorized_message":{"type":"string"},"passing_percentage":{"type":"number"},"time_limit":{"type":"integer"},"show_correct_answers":{"type":"boolean"},"disable_content_while_in_quiz":{"type":"boolean"},"preferred_playback_rate_disabled":{"type":"boolean"},"allow_multiple_completions":{"type":"boolean"},"start_from_beginning":{"type":"boolean"},"loop_asset":{"type":"boolean"},"course_module":{"$ref":"#/components/schemas/CourseModule","readOnly":true},"course_module_id":{"type":"integer"},"asset":{"$ref":"#/components/schemas/Asset","readOnly":true},"asset_id":{"type":"integer"},"thumbnail":{"$ref":"#/components/schemas/Asset","readOnly":true},"thumbnail_id":{"type":"integer"},"author":{"$ref":"#/components/schemas/User","readOnly":true},"author_id":{"type":"integer"},"worksheet":{"$ref":"#/components/schemas/Worksheet","readOnly":true},"worksheet_id":{"type":"integer"},"survey":{"$ref":"#/components/schemas/Survey","readOnly":true},"survey_id":{"type":"integer"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"readOnly":true},"attachment_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["title","type","course_module_id","created_at","updated_at"]},"CourseLessonOptional":{"type":"object","properties":{"title":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string"},"publish_status":{"type":"string"},"date":{"type":"string","format":"date-time"},"publish_at":{"type":"string","format":"date-time"},"body_media_type":{"type":"string"},"media_duration_seconds":{"type":"integer"},"total_views":{"type":"integer"},"expand_additional_content":{"type":"boolean"},"hide_additional_content_toggles":{"type":"boolean"},"show_unauthorized_course":{"type":"string","enum":["show","hide","overview"]},"show_unauthorized_lesson":{"type":"string","enum":["overview","hide","content"]},"unauthorized_message":{"type":"string"},"passing_percentage":{"type":"number"},"time_limit":{"type":"integer"},"show_correct_answers":{"type":"boolean"},"disable_content_while_in_quiz":{"type":"boolean"},"preferred_playback_rate_disabled":{"type":"boolean"},"allow_multiple_completions":{"type":"boolean"},"start_from_beginning":{"type":"boolean"},"loop_asset":{"type":"boolean"},"asset_id":{"type":"integer"},"thumbnail_id":{"type":"integer"},"author_id":{"type":"integer"},"worksheet_id":{"type":"integer"},"survey_id":{"type":"integer"},"attachment_ids":{"type":"array","items":{"type":"integer"}}}},"CourseModule":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"color":{"type":"string"},"publish_status":{"type":"string"},"drip_days_count":{"type":"integer","readOnly":true},"publish_at":{"type":"string","format":"date-time"},"course":{"$ref":"#/components/schemas/Course","readOnly":true},"course_id":{"type":"integer"},"lessons":{"type":"array","items":{"$ref":"#/components/schemas/CourseLesson"},"readOnly":true},"lesson_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["title","course_id","created_at","updated_at"]},"CourseModuleOptional":{"type":"object","properties":{"title":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"color":{"type":"string"},"publish_status":{"type":"string"},"publish_at":{"type":"string","format":"date-time"},"lesson_ids":{"type":"array","items":{"type":"integer"}}}},"CourseOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string"},"publish_status":{"type":"string"},"publish_at":{"type":"string","format":"date-time"},"display_mode":{"type":"string"},"comments_mode":{"type":"string"},"completion_enabled":{"type":"boolean"},"require_completion":{"type":"boolean"},"access_restricted":{"type":"boolean"},"autoplay_enabled":{"type":"boolean"},"prevent_downloads":{"type":"boolean"},"podcast_enabled":{"type":"boolean"},"show_lesson_author":{"type":"boolean"},"hide_content_counts":{"type":"boolean"},"hide_content_duration":{"type":"boolean"},"allow_private_note":{"type":"boolean"},"add_lessons_to_top":{"type":"boolean"},"award_certificates":{"type":"boolean"},"exclude_from_new_content":{"type":"boolean"},"show_unauthorized":{"type":"string"},"unauthorized_btn_type":{"type":"integer"},"unauthorized_btn_label":{"type":"string"},"unauthorized_btn_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"unauthorized_message":{"type":"string"},"site_group_id":{"type":"integer"},"catalog_image_id":{"type":"integer"},"app_card_image_id":{"type":"integer"},"description_background_image_id":{"type":"integer"},"default_lesson_thumbnail_id":{"type":"integer"},"unauthorized_btn_product_id":{"type":"integer"},"module_ids":{"type":"array","items":{"type":"integer"}},"product_ids":{"type":"array","items":{"type":"integer"}}}},"Credit":{"type":"object","properties":{"expiration_count":{"type":"integer"},"expiration_unit":{"type":"string"},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}}}},"Customer":{"type":"object","properties":{"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"key":{"type":"string","readOnly":true},"first_names":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"do_not_contact":{"type":"boolean"},"do_not_sms":{"type":"boolean"},"locale":{"type":"string"},"active_denorm":{"type":"boolean","readOnly":true},"lead_score":{"type":"number","readOnly":true},"archived_at":{"type":"string","format":"date-time","readOnly":true},"affiliate":{"$ref":"#/components/schemas/Affiliate","readOnly":true},"affiliate_id":{"type":"integer"},"funnel":{"$ref":"#/components/schemas/Funnel","readOnly":true},"funnel_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/User","readOnly":true},"user_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["email","lead_score"]},"CustomerNote":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/User","readOnly":true},"user_id":{"type":"integer"},"noted_object":{"type":"object","readOnly":true},"noted_object_id":{"type":"integer"},"noted_object_type":{"type":"string"},"title":{"type":"string"},"kind":{"type":"string"},"private":{"type":"boolean"},"body_is_html":{"type":"boolean"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["customer_id","created_at","updated_at"]},"CustomerNoteOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"user_id":{"type":"integer"},"noted_object_id":{"type":"integer"},"noted_object_type":{"type":"string"},"title":{"type":"string"},"kind":{"type":"string"},"private":{"type":"boolean"},"body_is_html":{"type":"boolean"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"}}},"CustomerOptional":{"type":"object","properties":{"field_value_ids":{"type":"array","items":{"type":"integer"}},"first_names":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"phone_number":{"type":"string"},"do_not_contact":{"type":"boolean"},"do_not_sms":{"type":"boolean"},"locale":{"type":"string"},"affiliate_id":{"type":"integer"},"funnel_id":{"type":"integer"},"user_id":{"type":"integer"}}},"DateFilter":{"type":"object","properties":{"preset":{"type":"string","enum":["today","past","future","yesterday","this_week","this_month","this_quarter","this_year","last_week","last_month","last_quarter","last_year","since_week","since_month","since_quarter","since_year","custom"]},"from":{"type":"string","format":"date","description":"Only when preset is custom"},"to":{"type":"string","format":"date","description":"Only when preset is custom"}}},"Deal":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"value_cents":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"purchase":{"$ref":"#/components/schemas/Purchase","readOnly":true},"purchase_id":{"type":"integer"},"pipeline_stage":{"$ref":"#/components/schemas/PipelineStage","readOnly":true},"pipeline_stage_id":{"type":"integer"},"assignee":{"$ref":"#/components/schemas/User","readOnly":true},"assignee_id":{"type":"integer"},"last_activity_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}}},"required":["name","customer_id","pipeline_stage","pipeline_stage_id","last_activity_at","created_at","updated_at"]},"DealOptional":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"value_cents":{"type":"integer"},"customer_id":{"type":"integer"},"product_id":{"type":"integer"},"purchase_id":{"type":"integer"},"pipeline_stage_id":{"type":"integer"},"assignee_id":{"type":"integer"},"field_value_ids":{"type":"array","items":{"type":"integer"}}}},"EmailTemplate":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true}}},"Event":{"type":"object","properties":{"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"title":{"type":"string"},"subtitle":{"type":"string"},"internal_name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"description_is_html":{"type":"boolean"},"location_type":{"type":"string","enum":["url","simplero_live","in_person","zoom","google_meet","microsoft_teams","tbd","legacy"]},"location_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"location_text":{"type":"string"},"location_address":{"type":"string"},"event_type":{"type":"string","enum":["non_recurring_event_with_fixed_time","recurring_event_without_fixed_time","recurring_event_with_fixed_time"],"description":"To create a recurring event, also pass a recurrence_setting."},"approval_type":{"type":"string","enum":["automatically_approve_registrations","manually_approve_registrations","no_registrations_required"]},"registration_type":{"type":"string","enum":["any","each","multiple"],"description":"Only meaningful for recurring events"},"state":{"type":"string","readOnly":true},"asset":{"$ref":"#/components/schemas/Asset","readOnly":true},"asset_id":{"type":"integer"},"calendar":{"$ref":"#/components/schemas/Calendar","readOnly":true},"calendar_id":{"type":"integer"},"integration":{"$ref":"#/components/schemas/Integration","readOnly":true},"integration_id":{"type":"integer"},"funnel_step":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"funnel_step_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"max_participants_list":{"$ref":"#/components/schemas/List","readOnly":true},"max_participants_list_id":{"type":"integer"},"recording_course_module":{"$ref":"#/components/schemas/CourseModule","readOnly":true},"recording_course_module_id":{"type":"integer"},"scheduling_link":{"$ref":"#/components/schemas/SchedulingLink","readOnly":true,"description":"Set by the SchedulingLink booking flow. Not settable via the Event API."},"scheduling_link_id":{"type":"integer","description":"Set by the SchedulingLink booking flow. Not settable via the Event API."},"send_registration_info_email":{"type":"boolean"},"registration_info_email_subject":{"type":"string"},"registration_info_email_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"approved_registrant_content":{"type":"string","description":"Content shown only to approved registrants on the event page."},"approval_notification_emails":{"type":"string","description":"Comma-separated emails to notify whenever someone registers for this event."},"approval_notification_sms":{"type":"string","description":"Comma-separated phone numbers to text whenever someone registers for this event."},"registration_ends_minutes_before":{"type":"integer"},"max_participants":{"type":"integer"},"show_spots_remaining":{"type":"boolean","description":"Show how many spots are left on the event page (counts approved registrations against max_participants)."},"max_participants_custom_message":{"type":"string","description":"HTML content from a WYSIWYG editor"},"import_recording":{"type":"boolean"},"recording_title":{"type":"string"},"recording_position":{"type":"string","enum":["top","bottom"]},"recording_publish_status":{"type":"string","enum":["draft","published","dripped"]},"recording_drip_to":{"type":"string","enum":["all_participants","only_attendees"]},"preferred_recording_version":{"type":"string","enum":["speaker_with_screen","gallery_with_screen","speaker_without_screen","gallery_without_screen"]},"add_other_versions_as_attachments":{"type":"boolean"},"import_chat":{"type":"boolean"},"past_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"meta_conversion_event":{"type":"string","description":"Facebook/Meta Pixel event fired on registration. Common values: \"CompleteRegistration\", \"Schedule\", \"Lead\", \"SubmitApplication\", \"Contact\". Accepts custom event names."},"rescheduling_policy":{"type":"string","description":"Scheduling-link events only. One of \"allow\", \"disallow\", or (for master links) \"allow_master\"."},"indexed":{"type":"boolean","description":"Whether this event should appear in site search indexes."},"recurrence_setting":{"$ref":"#/components/schemas/EventRecurrenceSetting","description":"Recurrence rule. Pass this at creation time to make a recurring event — EventOccurrences are auto-generated from it."},"occurrences":{"type":"array","items":{"$ref":"#/components/schemas/EventOccurrence"},"description":"For non-recurring events, pass a single occurrence with starts_at_in_time_zone, ends_at_in_time_zone, time_zone at creation time. For recurring events, occurrences are generated from recurrence_setting instead."},"occurrence_ids":{"type":"array","items":{"type":"integer"},"description":"For non-recurring events, pass a single occurrence with starts_at_in_time_zone, ends_at_in_time_zone, time_zone at creation time. For recurring events, occurrences are generated from recurrence_setting instead."},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"},"readOnly":true},"site_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["title","internal_name","created_at","updated_at"]},"EventOccurrence":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"title":{"type":"string"},"description":{"type":"string"},"event":{"$ref":"#/components/schemas/Event","readOnly":true},"event_id":{"type":"integer"},"starts_at":{"type":"string","format":"date-time"},"ends_at":{"type":"string","format":"date-time"},"time_zone":{"type":"string"},"status":{"type":"string","enum":["confirmed","canceled","payment_pending"]},"past_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"cancelation_reason":{"type":"string"},"rescheduling_reason":{"type":"string"},"lesson":{"$ref":"#/components/schemas/CourseLesson","readOnly":true,"description":"The CourseLesson created when a Zoom recording is imported."},"lesson_id":{"type":"integer","description":"The CourseLesson created when a Zoom recording is imported."},"asset":{"$ref":"#/components/schemas/Asset","readOnly":true,"description":"The Asset for the imported recording (video/audio file)."},"asset_id":{"type":"integer","description":"The Asset for the imported recording (video/audio file)."},"participants":{"type":"array","items":{"$ref":"#/components/schemas/EventOccurrenceParticipant"},"readOnly":true},"participant_ids":{"type":"array","items":{"type":"integer"}},"sites":{"type":"array","items":{"$ref":"#/components/schemas/Site"},"readOnly":true},"site_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"EventOccurrenceParticipant":{"type":"object","properties":{"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"customer":{"$ref":"#/components/schemas/Customer"},"customer_id":{"type":"integer"},"event":{"$ref":"#/components/schemas/Event","readOnly":true},"event_occurrence":{"$ref":"#/components/schemas/EventOccurrence","readOnly":true},"event_occurrence_id":{"type":"integer"},"funnel_step":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"funnel_step_id":{"type":"integer"},"affiliate":{"$ref":"#/components/schemas/Affiliate","readOnly":true},"affiliate_id":{"type":"integer"},"affiliate_link":{"$ref":"#/components/schemas/AffiliateLink","readOnly":true},"affiliate_link_id":{"type":"integer"},"starts_at":{"type":"string","format":"date-time","readOnly":true},"role":{"type":"string","enum":["attendee","organizer","scheduler"]},"registration_state":{"type":"string","enum":["approved","pending","canceled","denied","waiting_payment","payment_timed_out","contract_pending"]},"registered_at":{"type":"string","format":"date-time","readOnly":true},"first_joined_at":{"type":"string","format":"date-time","readOnly":true},"last_joined_at":{"type":"string","format":"date-time","readOnly":true},"last_left_at":{"type":"string","format":"date-time","readOnly":true},"duration_attended_in_seconds":{"type":"integer"},"time_zone":{"type":"string"},"join_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"created_customer":{"type":"boolean"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"},"utm_keyword":{"type":"string"},"utm_adgroup":{"type":"string"},"ref":{"type":"string"},"track":{"type":"string"},"referrer":{"type":"string"},"ip_address":{"type":"string"},"user_agent":{"type":"string"},"device_type":{"type":"string","enum":["mobile","desktop"]},"screen_size":{"type":"string"},"request_locale":{"type":"string"}}},"EventOptional":{"type":"object","properties":{"form_field_ids":{"type":"array","items":{"type":"integer"}},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"subtitle":{"type":"string"},"internal_name":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"description_is_html":{"type":"boolean"},"location_type":{"type":"string","enum":["url","simplero_live","in_person","zoom","google_meet","microsoft_teams","tbd","legacy"]},"location_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"location_text":{"type":"string"},"location_address":{"type":"string"},"approval_type":{"type":"string","enum":["automatically_approve_registrations","manually_approve_registrations","no_registrations_required"]},"registration_type":{"type":"string","enum":["any","each","multiple"],"description":"Only meaningful for recurring events"},"asset_id":{"type":"integer"},"calendar_id":{"type":"integer"},"integration_id":{"type":"integer"},"funnel_step_id":{"type":"integer"},"product_id":{"type":"integer"},"max_participants_list_id":{"type":"integer"},"recording_course_module_id":{"type":"integer"},"scheduling_link_id":{"type":"integer","description":"Set by the SchedulingLink booking flow. Not settable via the Event API."},"send_registration_info_email":{"type":"boolean"},"registration_info_email_subject":{"type":"string"},"registration_info_email_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"approved_registrant_content":{"type":"string","description":"Content shown only to approved registrants on the event page."},"approval_notification_emails":{"type":"string","description":"Comma-separated emails to notify whenever someone registers for this event."},"approval_notification_sms":{"type":"string","description":"Comma-separated phone numbers to text whenever someone registers for this event."},"registration_ends_minutes_before":{"type":"integer"},"max_participants":{"type":"integer"},"show_spots_remaining":{"type":"boolean","description":"Show how many spots are left on the event page (counts approved registrations against max_participants)."},"max_participants_custom_message":{"type":"string","description":"HTML content from a WYSIWYG editor"},"import_recording":{"type":"boolean"},"recording_title":{"type":"string"},"recording_position":{"type":"string","enum":["top","bottom"]},"recording_publish_status":{"type":"string","enum":["draft","published","dripped"]},"recording_drip_to":{"type":"string","enum":["all_participants","only_attendees"]},"preferred_recording_version":{"type":"string","enum":["speaker_with_screen","gallery_with_screen","speaker_without_screen","gallery_without_screen"]},"add_other_versions_as_attachments":{"type":"boolean"},"import_chat":{"type":"boolean"},"past_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"meta_conversion_event":{"type":"string","description":"Facebook/Meta Pixel event fired on registration. Common values: \"CompleteRegistration\", \"Schedule\", \"Lead\", \"SubmitApplication\", \"Contact\". Accepts custom event names."},"rescheduling_policy":{"type":"string","description":"Scheduling-link events only. One of \"allow\", \"disallow\", or (for master links) \"allow_master\"."},"indexed":{"type":"boolean","description":"Whether this event should appear in site search indexes."},"recurrence_setting":{"$ref":"#/components/schemas/EventRecurrenceSetting","description":"Recurrence rule. Pass this at creation time to make a recurring event — EventOccurrences are auto-generated from it."},"occurrences":{"type":"array","items":{"$ref":"#/components/schemas/EventOccurrence"},"description":"For non-recurring events, pass a single occurrence with starts_at_in_time_zone, ends_at_in_time_zone, time_zone at creation time. For recurring events, occurrences are generated from recurrence_setting instead."},"occurrence_ids":{"type":"array","items":{"type":"integer"},"description":"For non-recurring events, pass a single occurrence with starts_at_in_time_zone, ends_at_in_time_zone, time_zone at creation time. For recurring events, occurrences are generated from recurrence_setting instead."},"site_ids":{"type":"array","items":{"type":"integer"}}}},"EventRecurrenceSetting":{"type":"object","properties":{"repeat_unit":{"type":"string","enum":["non_recurring","daily","weekly","monthly"]},"repeat_interval":{"type":"integer"},"weekly_days":{"type":"string","description":"Comma-separated list of weekday numbers (1=Monday through 7=Sunday), e.g. \"1,3,5\" for Mon/Wed/Fri. Only used when repeat_unit is \"weekly\"."},"monthly_day":{"type":"integer","description":"Day of month (1–31). Used when repeat_unit is \"monthly\" and the rule is \"repeat on day N\"."},"monthly_week":{"type":"integer","description":"Week of month (1–4, or -1 for the last week). Used with monthly_week_day when the rule is \"repeat on the Nth weekday\"."},"monthly_week_day":{"type":"integer","description":"Weekday number (1=Monday through 7=Sunday) paired with monthly_week."},"end_times":{"type":"integer","description":"Stop after this many occurrences. Mutually exclusive with end_at."},"end_at":{"type":"string","format":"date-time","description":"Stop generating occurrences at/after this datetime. Mutually exclusive with end_times."}},"required":["repeat_unit"]},"FacetValue":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Field":{"type":"object","properties":{"label":{"type":"string"},"internal_name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer"},"key":{"type":"string","description":"Unique key used to interpolate the field value in templates, e.g. {{field.\u003ckey\u003e}}"},"field_type":{"type":"string","enum":["f_in_table_name","f_in_table_email","f_text","f_name","f_email","f_gender","f_url","f_age","f_birth_date","f_text_area","f_phone","f_address","f_time_zone","f_facebook_url","f_x_username","f_skype_name","f_radio_button","f_check_box","f_check_boxes","f_select","f_acceptance","f_date","f_datetime","f_integer","f_decimal","f_us_state","f_country","f_currency","f_money","f_scale_rating","f_yes_no","f_tiktok_handle","f_instagram_username","f_linkedin_username","f_youtube_handle","f_pinterest_username","f_reddit_username","f_heading","f_switch","f_divider","f_section","f_file","f_hidden","f_countdown_timer_option"]},"customer_editable":{"type":"boolean","description":"Whether contacts can edit this field's value in public-facing forms"},"subheading":{"type":"string","description":"Smaller text shown below the field label"},"content":{"type":"string","description":"HTML content for acceptance and heading/section fields"},"min":{"type":"integer","description":"Minimum value for scale/rating fields"},"max":{"type":"integer","description":"Maximum value for scale/rating fields"},"min_label":{"type":"string","description":"Label shown at the minimum end of a scale/rating"},"mid_label":{"type":"string","description":"Label shown at the midpoint of a scale/rating"},"max_label":{"type":"string","description":"Label shown at the maximum end of a scale/rating"},"countdown_timer":{"$ref":"#/components/schemas/CountdownTimer","readOnly":true},"countdown_timer_id":{"type":"integer"},"field_options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOption"},"readOnly":true},"field_option_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"FieldOption":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/Field","readOnly":true},"field_id":{"type":"integer"},"label":{"type":"string"},"position":{"type":"integer"},"score":{"type":"integer"},"other_option":{"type":"boolean","description":"When true, this option is an \"Other\" option that lets contacts enter their own value"},"other_placeholder":{"type":"string","description":"Placeholder text shown in the input when the \"Other\" option is selected"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["field_id","label","created_at","updated_at"]},"FieldOptionOptional":{"type":"object","properties":{"label":{"type":"string"},"position":{"type":"integer"},"score":{"type":"integer"},"other_option":{"type":"boolean","description":"When true, this option is an \"Other\" option that lets contacts enter their own value"},"other_placeholder":{"type":"string","description":"Placeholder text shown in the input when the \"Other\" option is selected"}}},"FieldOptionValue":{"type":"object","properties":{"field_value":{"$ref":"#/components/schemas/FieldValue","readOnly":true},"field_value_id":{"type":"integer"},"field_option":{"$ref":"#/components/schemas/FieldOption","readOnly":true},"field_option_id":{"type":"integer"}},"required":["field_value_id","field_option_id"]},"FieldOptional":{"type":"object","properties":{"label":{"type":"string"},"internal_name":{"type":"string"},"active":{"type":"boolean"},"position":{"type":"integer"},"key":{"type":"string","description":"Unique key used to interpolate the field value in templates, e.g. {{field.\u003ckey\u003e}}"},"customer_editable":{"type":"boolean","description":"Whether contacts can edit this field's value in public-facing forms"},"subheading":{"type":"string","description":"Smaller text shown below the field label"},"content":{"type":"string","description":"HTML content for acceptance and heading/section fields"},"min":{"type":"integer","description":"Minimum value for scale/rating fields"},"max":{"type":"integer","description":"Maximum value for scale/rating fields"},"min_label":{"type":"string","description":"Label shown at the minimum end of a scale/rating"},"mid_label":{"type":"string","description":"Label shown at the midpoint of a scale/rating"},"max_label":{"type":"string","description":"Label shown at the maximum end of a scale/rating"},"countdown_timer_id":{"type":"integer"},"field_option_ids":{"type":"array","items":{"type":"integer"}}}},"FieldValue":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/Field","readOnly":true},"field_id":{"type":"integer"},"owner":{"type":"object","readOnly":true},"owner_id":{"type":"integer"},"owner_type":{"type":"string"},"subfield":{"type":"string","enum":["value","first_names","last_name","address","address_2","postal_code","city","region","country_code","number","date","time","region_code","other"]},"text_value":{"type":"string"},"int_value":{"type":"integer"},"date_value":{"type":"string","format":"date-time"},"datetime_value":{"type":"string","format":"date-time"},"boolean_value":{"type":"boolean"},"decimal_value":{"type":"number"},"field_options":{"type":"array","items":{"$ref":"#/components/schemas/FieldOption"},"readOnly":true},"field_option_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["field_id","owner_id","owner_type"]},"FormField":{"type":"object","properties":{"field":{"$ref":"#/components/schemas/Field"},"field_id":{"type":"integer"},"owner":{"type":"object","readOnly":true},"owner_id":{"type":"integer"},"owner_type":{"type":"string"},"purpose":{"type":"string","enum":["participant","purchase","contact","survey","affiliate","member","pipeline","builder_doc"]},"name_option":{"type":"string","enum":["first_name","one_field","two_fields"]},"label":{"type":"string"},"placeholder":{"type":"string"},"help_text":{"type":"string"},"required":{"type":"boolean"},"active":{"type":"boolean"},"position":{"type":"integer"}},"required":["field_id"]},"FormFieldOptional":{"type":"object","properties":{"owner_id":{"type":"integer"},"owner_type":{"type":"string"},"purpose":{"type":"string","enum":["participant","purchase","contact","survey","affiliate","member","pipeline","builder_doc"]},"name_option":{"type":"string","enum":["first_name","one_field","two_fields"]},"label":{"type":"string"},"placeholder":{"type":"string"},"help_text":{"type":"string"},"required":{"type":"boolean"},"active":{"type":"boolean"},"position":{"type":"integer"}}},"Funnel":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"stealme_token":{"type":"string","readOnly":true},"name":{"type":"string"},"url_type":{"type":"string","enum":["canonical","custom_domain","site"]},"url_site_path":{"type":"string"},"url_site":{"$ref":"#/components/schemas/Site","readOnly":true},"url_site_id":{"type":"integer"},"theme":{"$ref":"#/components/schemas/Theme","readOnly":true},"theme_id":{"type":"integer"},"style_guide":{"$ref":"#/components/schemas/StyleGuide","readOnly":true},"style_guide_id":{"type":"integer"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"custom_tracking_code":{"type":"string"},"custom_tracking_code_for_body":{"type":"string"},"steps":{"type":"array","items":{"$ref":"#/components/schemas/FunnelStep"},"readOnly":true},"step_ids":{"type":"array","items":{"type":"integer"}},"connectors":{"type":"array","items":{"$ref":"#/components/schemas/FunnelConnector"},"readOnly":true},"connector_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","created_at","updated_at"]},"FunnelConnector":{"type":"object","properties":{"funnel":{"$ref":"#/components/schemas/Funnel","readOnly":true},"funnel_id":{"type":"integer","readOnly":true},"parent":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"parent_id":{"type":"integer"},"child":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"child_id":{"type":"integer"},"name":{"type":"string"},"position":{"type":"integer"},"weight":{"type":"integer","description":"Split-test traffic allocation (0–100). 0 = disabled. For non-split connectors, ignored."},"otherwise_branch":{"type":"boolean","readOnly":true,"description":"On condition steps, true marks the fallback branch taken when no other connector's rules match."},"created_blank":{"type":"boolean","readOnly":true,"description":"True if this connector was created as an empty branch (no rules, no steps inside) waiting to be filled in."}},"required":["funnel","funnel_id","parent","parent_id","child","child_id"]},"FunnelConnectorOptional":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer"},"weight":{"type":"integer","description":"Split-test traffic allocation (0–100). 0 = disabled. For non-split connectors, ignored."}}},"FunnelOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"url_type":{"type":"string","enum":["canonical","custom_domain","site"]},"url_site_path":{"type":"string"},"url_site_id":{"type":"integer"},"theme_id":{"type":"integer"},"style_guide_id":{"type":"integer"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"custom_tracking_code":{"type":"string"},"custom_tracking_code_for_body":{"type":"string"},"step_ids":{"type":"array","items":{"type":"integer"}},"connector_ids":{"type":"array","items":{"type":"integer"}}}},"FunnelStep":{"type":"object","properties":{"funnel":{"$ref":"#/components/schemas/Funnel","readOnly":true},"funnel_id":{"type":"integer"},"step_type":{"type":"string","enum":["first","split_test","condition","join","page","product","survey","scheduling_link","redirect","last"]},"name":{"type":"string"},"slug":{"type":"string"},"live":{"type":"boolean"},"archived":{"type":"boolean"},"landing_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"landing_page_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"survey":{"$ref":"#/components/schemas/Survey","readOnly":true},"scheduling_link":{"$ref":"#/components/schemas/SchedulingLink","readOnly":true},"survey_id":{"type":"integer"},"scheduling_link_id":{"type":"integer"},"redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"offline_behavior":{"type":"string","enum":["not_found","funnel_start","funnel_step","redirect_url"]},"offline_funnel_step":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"offline_funnel_step_id":{"type":"integer"},"offline_redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"split_step":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"split_step_id":{"type":"integer"},"parent_connectors":{"type":"array","items":{"$ref":"#/components/schemas/FunnelConnector"},"readOnly":true},"parent_connector_ids":{"type":"array","items":{"type":"integer"}},"child_connectors":{"type":"array","items":{"$ref":"#/components/schemas/FunnelConnector"},"readOnly":true},"child_connector_ids":{"type":"array","items":{"type":"integer"}},"unique_views":{"type":"integer","readOnly":true},"total_views":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["funnel_id","name","created_at","updated_at"]},"FunnelStepOptional":{"type":"object","properties":{"name":{"type":"string"},"slug":{"type":"string"},"live":{"type":"boolean"},"archived":{"type":"boolean"},"landing_page_id":{"type":"integer"},"survey_id":{"type":"integer"},"scheduling_link_id":{"type":"integer"},"redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"offline_behavior":{"type":"string","enum":["not_found","funnel_start","funnel_step","redirect_url"]},"offline_funnel_step_id":{"type":"integer"},"offline_redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"split_step_id":{"type":"integer"},"parent_connector_ids":{"type":"array","items":{"type":"integer"}},"child_connector_ids":{"type":"array","items":{"type":"integer"}}}},"GeoFilter":{"type":"object","properties":{"distance":{"type":"string","enum":["5","10","25","50","100","200","300","400","500","750","1000"]},"location":{"type":"string"}}},"Idea":{"type":"object","properties":{"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"description":{"type":"string"},"admin_notes":{"type":"string"},"submitted_at":{"type":"string","format":"date-time"},"upvotes_count":{"type":"integer","readOnly":true},"comments_count":{"type":"integer","readOnly":true},"pipeline_stage":{"$ref":"#/components/schemas/PipelineStage","readOnly":true},"pipeline_stage_id":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"assignee":{"$ref":"#/components/schemas/User","readOnly":true},"assignee_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}}},"required":["title","description","submitted_at","pipeline_stage","pipeline_stage_id","customer","customer_id","created_at","updated_at"]},"IdeaOptional":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"description":{"type":"string"},"admin_notes":{"type":"string"},"submitted_at":{"type":"string","format":"date-time"},"customer_id":{"type":"integer"},"assignee_id":{"type":"integer"},"field_value_ids":{"type":"array","items":{"type":"integer"}}}},"Installment":{"type":"object","properties":{"delta_count":{"type":"integer"},"delta_unit":{"type":"string"},"period":{"$ref":"#/components/schemas/PricePeriod","readOnly":true},"price_period_id":{"type":"integer"},"alternative_prices":{"type":"array","items":{"$ref":"#/components/schemas/AlternativePrice"},"readOnly":true},"alternative_price_ids":{"type":"array","items":{"type":"integer"}},"position":{"type":"integer"},"wait_for":{"type":"string"},"delta_sign":{"type":"integer"},"price_cents":{"type":"integer"},"repetitions":{"type":"integer"},"milestone_text":{"type":"string"},"due_on":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["price_period_id","created_at","updated_at"]},"InstallmentOptional":{"type":"object","properties":{"delta_count":{"type":"integer"},"delta_unit":{"type":"string"},"alternative_price_ids":{"type":"array","items":{"type":"integer"}},"position":{"type":"integer"},"wait_for":{"type":"string"},"delta_sign":{"type":"integer"},"price_cents":{"type":"integer"},"repetitions":{"type":"integer"},"milestone_text":{"type":"string"},"due_on":{"type":"string","format":"date-time"}}},"Integration":{"type":"object","properties":{"token":{"type":"string","readOnly":true}}},"Integrations::Zoom":{"type":"object","properties":{"token":{"type":"string","readOnly":true}}},"Invitation":{"type":"object","properties":{"token":{"type":"string","readOnly":true}},"required":["token"]},"Label":{"type":"object","properties":{"name":{"type":"string"},"label_color":{"type":"string"},"text_color":{"type":"string"},"show_in_admin":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","created_at","updated_at"]},"LabelOptional":{"type":"object","properties":{"name":{"type":"string"},"label_color":{"type":"string"},"text_color":{"type":"string"},"show_in_admin":{"type":"boolean"}}},"Labeling":{"type":"object","properties":{"label":{"$ref":"#/components/schemas/Label","readOnly":true},"label_id":{"type":"integer"},"labeled_object":{"type":"object","readOnly":true},"labeled_object_id":{"type":"integer"},"labeled_object_type":{"type":"string"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["label_id","created_at","updated_at"]},"LandingPage":{"type":"object","properties":{"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"stealme_token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"content_builder_doc_id":{"type":"integer","readOnly":true,"description":"ID of the content BuilderDoc owned by this LandingPage."},"name":{"type":"string"},"page_type":{"type":"string","enum":["embedded","raw","themed_full","builder_doc"]},"locale":{"type":"string"},"active":{"type":"boolean"},"publish_status":{"type":"string"},"show_in_admin":{"type":"boolean"},"hide_from_customers":{"type":"boolean"},"permanent_redirect":{"type":"boolean"},"expires_at":{"type":"string","format":"date-time","readOnly":true},"deleted_at":{"type":"string","format":"date-time","readOnly":true},"page_title":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"color_mode":{"type":"string"},"noindex":{"type":"boolean"},"meta_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"meta_image_id":{"type":"integer"},"favicon":{"$ref":"#/components/schemas/Asset","readOnly":true},"favicon_id":{"type":"integer"},"cta_object":{"type":"object","readOnly":true},"cta_object_id":{"type":"integer"},"cta_object_type":{"type":"string"},"inactive_action":{"type":"string"},"inactive_redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"custom_tracking_code":{"type":"string","description":"Only relevant when page_type is themed_full or builder_doc."},"custom_tracking_code_for_body":{"type":"string","description":"Only relevant when page_type is themed_full or builder_doc."},"desktop_preview_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"desktop_preview_image_id":{"type":"integer"},"url_type":{"type":"string","enum":["canonical","custom_domain","site"],"description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"url_site":{"$ref":"#/components/schemas/Site","readOnly":true,"description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"url_site_id":{"type":"integer","description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"url_site_path":{"type":"string","description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"unique_displays":{"type":"integer","readOnly":true},"conversions":{"type":"integer","readOnly":true},"total_displays":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name"]},"LandingPageOptional":{"type":"object","properties":{"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"locale":{"type":"string"},"active":{"type":"boolean"},"publish_status":{"type":"string"},"show_in_admin":{"type":"boolean"},"hide_from_customers":{"type":"boolean"},"permanent_redirect":{"type":"boolean"},"page_title":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"color_mode":{"type":"string"},"noindex":{"type":"boolean"},"meta_image_id":{"type":"integer"},"favicon_id":{"type":"integer"},"cta_object_id":{"type":"integer"},"cta_object_type":{"type":"string"},"inactive_action":{"type":"string"},"inactive_redirect_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"custom_tracking_code":{"type":"string","description":"Only relevant when page_type is themed_full or builder_doc."},"custom_tracking_code_for_body":{"type":"string","description":"Only relevant when page_type is themed_full or builder_doc."},"desktop_preview_image_id":{"type":"integer"},"url_type":{"type":"string","enum":["canonical","custom_domain","site"],"description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"url_site_id":{"type":"integer","description":"URL routing. Only relevant when page_type is themed_full or builder_doc."},"url_site_path":{"type":"string","description":"URL routing. Only relevant when page_type is themed_full or builder_doc."}}},"LibraryMailing":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"body_editor":{"type":"string"},"subject":{"type":"string"},"preheader":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"template":{"$ref":"#/components/schemas/EmailTemplate","readOnly":true},"email_template_id":{"type":"integer"},"recipients_segment":{"$ref":"#/components/schemas/Segment","readOnly":true},"recipients_segment_id":{"type":"integer"},"user":{"$ref":"#/components/schemas/User","readOnly":true},"user_id":{"type":"integer"},"hide_from_archive":{"type":"boolean"},"hide_web_version":{"type":"boolean"},"hide_from_recents":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"non_warming":{"type":"boolean"},"split_test":{"type":"boolean"},"subject_b":{"type":"string"},"preheader_b":{"type":"string"},"test_percentage":{"type":"integer"},"test_duration_minutes":{"type":"integer"},"state":{"type":"string","readOnly":true},"recipients_count":{"type":"integer","readOnly":true},"subject_a_open_rate":{"type":"number","readOnly":true},"subject_b_open_rate":{"type":"number","readOnly":true},"spam_score":{"type":"number","readOnly":true},"spam_hits":{"type":"string","readOnly":true},"for_single_action":{"type":"boolean","readOnly":true},"deliveries_finalized":{"type":"boolean","readOnly":true},"delivered_at":{"type":"string","format":"date-time","readOnly":true},"deliver_at":{"type":"string","format":"date-time","readOnly":true},"queued_at":{"type":"string","format":"date-time","readOnly":true},"body_updated_at":{"type":"string","format":"date-time","readOnly":true},"start_delivering_at":{"type":"string","format":"date-time","readOnly":true},"first_delivery_at":{"type":"string","format":"date-time","readOnly":true},"last_delivery_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["email_template_id"]},"LibraryMailingOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"body_editor":{"type":"string"},"subject":{"type":"string"},"preheader":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"email_template_id":{"type":"integer"},"recipients_segment_id":{"type":"integer"},"user_id":{"type":"integer"},"hide_from_archive":{"type":"boolean"},"hide_web_version":{"type":"boolean"},"hide_from_recents":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"non_warming":{"type":"boolean"},"split_test":{"type":"boolean"},"subject_b":{"type":"string"},"preheader_b":{"type":"string"},"test_percentage":{"type":"integer"},"test_duration_minutes":{"type":"integer"}}},"List":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"internal_name":{"type":"string"},"handle":{"type":"string"},"require_confirmation":{"type":"boolean"},"customize_confirmation_email":{"type":"boolean"},"confirm_email_subject":{"type":"string"},"confirm_email_preheader":{"type":"string"},"confirm_button_label":{"type":"string"},"confirm_email_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"sender_verified_email_id":{"type":"integer"},"reply_to_verified_email_id":{"type":"integer"},"broadcast_subject_prefix":{"type":"string"},"broadcast_footer":{"type":"string"},"notify_email":{"type":"string","format":"email"},"archive":{"type":"string"},"thank_you_page_title":{"type":"string"},"thank_you_page_tracking_code":{"type":"string"},"thank_you_page_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"return_to":{"type":"string"},"confirm_pending_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"unsubscribed_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"email_field_name":{"type":"string","readOnly":true},"meta_conversion_event":{"type":"string"},"antibot_preference":{"type":"string","enum":["suspicious_signups","all_signups","never"]},"send_login_email":{"type":"boolean"},"allow_legacy_form_signup":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"disable_gdpr_consent":{"type":"boolean"},"use_custom_gdpr_consent_message":{"type":"boolean"},"gdpr_consent_message":{"type":"string"},"auto_responses":{"type":"array","items":{"$ref":"#/components/schemas/AutoResponse"},"readOnly":true},"auto_response_ids":{"type":"array","items":{"type":"integer"}},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"readOnly":true},"trigger_ids":{"type":"array","items":{"type":"integer"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"readOnly":true},"attachment_ids":{"type":"array","items":{"type":"integer"}},"landing_pages":{"type":"array","items":{"$ref":"#/components/schemas/LandingPage"},"readOnly":true},"landing_page_ids":{"type":"array","items":{"type":"integer"}},"active_subscriber_count":{"type":"integer","readOnly":true},"attachments_count":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","internal_name"]},"ListOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"internal_name":{"type":"string"},"handle":{"type":"string"},"require_confirmation":{"type":"boolean"},"customize_confirmation_email":{"type":"boolean"},"confirm_email_subject":{"type":"string"},"confirm_email_preheader":{"type":"string"},"confirm_button_label":{"type":"string"},"confirm_email_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"sender_verified_email_id":{"type":"integer"},"reply_to_verified_email_id":{"type":"integer"},"broadcast_subject_prefix":{"type":"string"},"broadcast_footer":{"type":"string"},"notify_email":{"type":"string","format":"email"},"archive":{"type":"string"},"thank_you_page_title":{"type":"string"},"thank_you_page_tracking_code":{"type":"string"},"thank_you_page_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"return_to":{"type":"string"},"confirm_pending_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"unsubscribed_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"meta_conversion_event":{"type":"string"},"antibot_preference":{"type":"string","enum":["suspicious_signups","all_signups","never"]},"send_login_email":{"type":"boolean"},"allow_legacy_form_signup":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"disable_gdpr_consent":{"type":"boolean"},"use_custom_gdpr_consent_message":{"type":"boolean"},"gdpr_consent_message":{"type":"string"},"auto_response_ids":{"type":"array","items":{"type":"integer"}},"trigger_ids":{"type":"array","items":{"type":"integer"}},"attachment_ids":{"type":"array","items":{"type":"integer"}},"landing_page_ids":{"type":"array","items":{"type":"integer"}}}},"NavList":{"type":"object","properties":{"name":{"type":"string"},"handle":{"type":"string"},"site":{"$ref":"#/components/schemas/Site","readOnly":true},"site_id":{"type":"integer"},"links":{"type":"array","items":{"$ref":"#/components/schemas/NavListLink"},"readOnly":true},"link_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","handle","site_id","created_at","updated_at"]},"NavListLink":{"type":"object","properties":{"nav_list":{"$ref":"#/components/schemas/NavList","readOnly":true},"nav_list_id":{"type":"integer"},"label":{"type":"string"},"hidden":{"type":"boolean"},"open_in_new_tab":{"type":"boolean"},"fa_icon":{"type":"string"},"parent_id":{"type":"integer"},"page_section_id":{"type":"string"},"link_type":{"type":"string","enum":["builder_doc_page","forum","feed","leaderboards","courses","courses_folder","coaching_programs","events","members","home","course","page_group","product","site_groups","site_group","blog","dashboard","external","catalog","support","terms","page_anchor","blog_post_template","product_category","favorites","playlists","history","podcast","bot","bots","ideas_board","webbook","coaching_program","page"]},"external_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"page":{"$ref":"#/components/schemas/Page","readOnly":true},"page_id":{"type":"integer"},"course":{"$ref":"#/components/schemas/Course","readOnly":true},"course_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"site_group":{"$ref":"#/components/schemas/SiteGroup","readOnly":true},"site_group_id":{"type":"integer"},"podcast":{"$ref":"#/components/schemas/Podcast","readOnly":true},"podcast_id":{"type":"integer"},"bot":{"$ref":"#/components/schemas/Bot","readOnly":true},"bot_id":{"type":"integer"},"pipeline":{"$ref":"#/components/schemas/Pipeline","readOnly":true},"pipeline_id":{"type":"integer"},"product_category":{"$ref":"#/components/schemas/ProductCategory","readOnly":true},"product_category_id":{"type":"integer"},"route":{"$ref":"#/components/schemas/Route","readOnly":true},"route_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["nav_list_id","label","created_at","updated_at"]},"NavListLinkOptional":{"type":"object","properties":{"label":{"type":"string"},"hidden":{"type":"boolean"},"open_in_new_tab":{"type":"boolean"},"fa_icon":{"type":"string"},"parent_id":{"type":"integer"},"page_section_id":{"type":"string"},"external_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"page_id":{"type":"integer"},"course_id":{"type":"integer"},"product_id":{"type":"integer"},"site_group_id":{"type":"integer"},"podcast_id":{"type":"integer"},"bot_id":{"type":"integer"},"pipeline_id":{"type":"integer"},"product_category_id":{"type":"integer"},"route_id":{"type":"integer"}}},"NumericFilter":{"type":"object","properties":{"op":{"type":"string","enum":["gte","gt","lte","lt","between","equals","not_equal"]},"value":{"type":"number"},"value2":{"type":"number","description":"Only when op is between"}}},"Offer":{"type":"object"},"OrderBump":{"type":"object"},"Page":{"type":"object","properties":{"content_builder_doc_id":{"type":"integer","readOnly":true,"description":"ID of the content BuilderDoc owned by this Page."},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"site":{"$ref":"#/components/schemas/Site","readOnly":true},"site_id":{"type":"integer"},"title":{"type":"string"},"internal_name":{"type":"string"},"slug":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"meta_image_id":{"type":"integer"},"color_mode":{"type":"string"},"noindex":{"type":"boolean"},"hide_from_site_search":{"type":"boolean"},"hide_from_ai_bots":{"type":"boolean"},"publish_status":{"type":"string"},"publish_at":{"type":"string","format":"date-time"},"builder_doc":{"type":"boolean","description":"True for Page Builder 2.0 pages, false for legacy themed pages. Cannot be changed after creation."},"total_views":{"type":"integer","readOnly":true},"unique_views":{"type":"integer","readOnly":true},"deleted_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["site","site_id","title","internal_name","created_at","updated_at"]},"PageOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"slug":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"meta_image_id":{"type":"integer"},"color_mode":{"type":"string"},"noindex":{"type":"boolean"},"hide_from_site_search":{"type":"boolean"},"hide_from_ai_bots":{"type":"boolean"},"publish_status":{"type":"string"},"publish_at":{"type":"string","format":"date-time"}}},"Pipeline":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"show_in_admin":{"type":"boolean"},"default":{"type":"boolean"},"entry_type":{"type":"string","enum":["deal","ticket","idea"]},"stages":{"type":"array","items":{"$ref":"#/components/schemas/PipelineStage"},"readOnly":true},"stage_ids":{"type":"array","items":{"type":"integer"},"readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","entry_type","created_at","updated_at"]},"PipelineOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"form_field_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"show_in_admin":{"type":"boolean"},"default":{"type":"boolean"}}},"PipelineStage":{"type":"object","properties":{"pipeline":{"$ref":"#/components/schemas/Pipeline","readOnly":true},"pipeline_id":{"type":"integer"},"name":{"type":"string"},"status":{"type":"string","enum":["open","won","lost","abandoned","waiting","closed","done","duplicate"]},"position":{"type":"integer"},"tooltip":{"type":"string"},"probability":{"type":"integer"},"auto_move_on_purchase":{"type":"boolean"},"auto_move_on_reply":{"type":"boolean"},"color":{"type":"string","description":"Background hex color code for this stage (falls back to a default per status when blank)"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["pipeline_id","name","status","position","created_at","updated_at"]},"PipelineStageOptional":{"type":"object","properties":{"name":{"type":"string"},"status":{"type":"string","enum":["open","won","lost","abandoned","waiting","closed","done","duplicate"]},"position":{"type":"integer"},"tooltip":{"type":"string"},"probability":{"type":"integer"},"auto_move_on_purchase":{"type":"boolean"},"auto_move_on_reply":{"type":"boolean"},"color":{"type":"string","description":"Background hex color code for this stage (falls back to a default per status when blank)"}}},"Podcast":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"host_name":{"type":"string"},"language":{"type":"string"},"category":{"type":"string"},"description":{"type":"string"}},"required":["title","internal_name","host_name","language","category"]},"Price":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"commitment_count":{"type":"integer"},"commitment_unit":{"type":"string"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"variant":{"$ref":"#/components/schemas/ProductVariant","readOnly":true},"product_variant_id":{"type":"integer"},"replaces_price":{"$ref":"#/components/schemas/Price","readOnly":true},"replaces_price_id":{"type":"integer"},"credit":{"$ref":"#/components/schemas/Credit","readOnly":true},"credit_id":{"type":"integer"},"periods":{"type":"array","items":{"$ref":"#/components/schemas/PricePeriod"},"readOnly":true},"period_ids":{"type":"array","items":{"type":"integer"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"},"readOnly":true},"offer_ids":{"type":"array","items":{"type":"integer"}},"order_bumps":{"type":"array","items":{"$ref":"#/components/schemas/OrderBump"},"readOnly":true},"order_bump_ids":{"type":"array","items":{"type":"integer"}},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"readOnly":true},"trigger_ids":{"type":"array","items":{"type":"integer"}},"purchases":{"type":"array","items":{"$ref":"#/components/schemas/Purchase"},"readOnly":true},"purchase_ids":{"type":"array","items":{"type":"integer"}},"replaced_by_prices":{"type":"array","items":{"$ref":"#/components/schemas/Price"},"readOnly":true},"replaced_by_price_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"subtitle":{"type":"string"},"badge":{"type":"string"},"internal_notes":{"type":"string"},"position":{"type":"integer"},"listing_type":{"type":"string","enum":["published","secret","coupon"]},"currency_type":{"type":"string","enum":["money","credit"]},"price_type":{"type":"string","enum":["purchase","subscription"]},"allow_donation":{"type":"boolean"},"prorate":{"type":"boolean"},"auto_renew":{"type":"string"},"coupon_code":{"type":"string"},"quantity_remain":{"type":"integer"},"min_quantity":{"type":"integer"},"payment_processors":{"type":"string"},"enabled":{"type":"boolean"},"authorize_only":{"type":"boolean"},"always_require_subscription":{"type":"boolean"},"donation_amount_label":{"type":"string"},"donation_free_label":{"type":"string"},"always_run":{"type":"boolean"},"credit_amount":{"type":"number"},"manage_mode":{"type":"string","enum":["allowed","locked"]},"has_trial":{"type":"boolean","readOnly":true},"allow_reservations":{"type":"boolean"},"show_quantity_remain":{"type":"boolean"},"advanced":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["token","product_id","position","created_at","updated_at"]},"PriceOptional":{"type":"object","properties":{"commitment_count":{"type":"integer"},"commitment_unit":{"type":"string"},"product_variant_id":{"type":"integer"},"replaces_price_id":{"type":"integer"},"credit_id":{"type":"integer"},"period_ids":{"type":"array","items":{"type":"integer"}},"offer_ids":{"type":"array","items":{"type":"integer"}},"order_bump_ids":{"type":"array","items":{"type":"integer"}},"trigger_ids":{"type":"array","items":{"type":"integer"}},"purchase_ids":{"type":"array","items":{"type":"integer"}},"replaced_by_price_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"subtitle":{"type":"string"},"badge":{"type":"string"},"internal_notes":{"type":"string"},"position":{"type":"integer"},"listing_type":{"type":"string","enum":["published","secret","coupon"]},"currency_type":{"type":"string","enum":["money","credit"]},"allow_donation":{"type":"boolean"},"prorate":{"type":"boolean"},"auto_renew":{"type":"string"},"coupon_code":{"type":"string"},"quantity_remain":{"type":"integer"},"min_quantity":{"type":"integer"},"payment_processors":{"type":"string"},"enabled":{"type":"boolean"},"authorize_only":{"type":"boolean"},"always_require_subscription":{"type":"boolean"},"donation_amount_label":{"type":"string"},"donation_free_label":{"type":"string"},"always_run":{"type":"boolean"},"credit_amount":{"type":"number"},"manage_mode":{"type":"string","enum":["allowed","locked"]},"allow_reservations":{"type":"boolean"},"show_quantity_remain":{"type":"boolean"},"advanced":{"type":"boolean"}}},"PricePeriod":{"type":"object","properties":{"duration_count":{"type":"integer"},"duration_unit":{"type":"string"},"price":{"$ref":"#/components/schemas/Price","readOnly":true},"price_id":{"type":"integer"},"installments":{"type":"array","items":{"$ref":"#/components/schemas/Installment"},"readOnly":true},"installment_ids":{"type":"array","items":{"type":"integer"}},"alternative_prices":{"type":"array","items":{"$ref":"#/components/schemas/AlternativePrice"},"readOnly":true},"alternative_price_ids":{"type":"array","items":{"type":"integer"}},"position":{"type":"integer"},"price_cents":{"type":"integer"},"count":{"type":"integer"},"duration_until":{"type":"string","format":"date-time"},"total_price_cents":{"type":"integer","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["price_id","created_at","updated_at"]},"PricePeriodOptional":{"type":"object","properties":{"duration_count":{"type":"integer"},"duration_unit":{"type":"string"},"installment_ids":{"type":"array","items":{"type":"integer"}},"alternative_price_ids":{"type":"array","items":{"type":"integer"}},"position":{"type":"integer"},"price_cents":{"type":"integer"},"count":{"type":"integer"},"duration_until":{"type":"string","format":"date-time"}}},"Product":{"type":"object","properties":{"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"credit_expiration_count":{"type":"integer","readOnly":true},"credit_expiration_unit":{"type":"string"},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"internal_name":{"type":"string"},"subtitle":{"type":"string"},"summary":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"long_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"listing_type":{"type":"string"},"sales_page_type":{"type":"string","enum":["catalog","landing_page","external","funnel"]},"product_type":{"type":"string","enum":["normal","credit"]},"tax_strategy_event_type":{"type":"string","enum":["public","private","online","none"]},"thank_you_page_behavior":{"type":"string","enum":["thank_you_page","redirect_url","redirect_content"]},"receipt_notifications":{"type":"string"},"sales_page_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"terms_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"welcome_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"sold_out_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"sales_start_at":{"type":"string","format":"date-time"},"sales_end_at":{"type":"string","format":"date-time"},"course_starts_at":{"type":"string","format":"date-time"},"position":{"type":"integer"},"show_in_admin":{"type":"boolean"},"thank_you_page_text":{"type":"string","description":"HTML content from a WYSIWYG editor"},"text_for_invoice":{"type":"string","description":"HTML content from a WYSIWYG editor"},"subscription_notification_extra_text":{"type":"string","description":"HTML content from a WYSIWYG editor"},"broadcast_subject_prefix":{"type":"string"},"broadcast_footer":{"type":"string"},"gdpr_consent_message":{"type":"string"},"use_custom_gdpr_consent_message":{"type":"boolean"},"disable_gdpr_consent":{"type":"boolean"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"send_login_email":{"type":"boolean"},"optin_type":{"type":"string","enum":["default","custom","none"]},"optin_label":{"type":"string"},"optin_sublabel":{"type":"string"},"hide_optin":{"type":"boolean"},"optin_pre_checked":{"type":"boolean"},"show_incl_tax":{"type":"boolean"},"tax_exempt":{"type":"boolean"},"vat_no_required":{"type":"boolean"},"dk_youth_vat_rule":{"type":"boolean"},"order_form_top":{"type":"string","description":"HTML content from a WYSIWYG editor"},"order_form_bottom":{"type":"string","description":"HTML content from a WYSIWYG editor"},"order_form_sidebar":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sold_out_message":{"type":"string","description":"HTML content from a WYSIWYG editor"},"ask_for_billing_address":{"type":"boolean"},"ask_for_company_info":{"type":"boolean"},"ask_for_coupon_code":{"type":"boolean"},"billing_address_required":{"type":"boolean"},"order_form_hide_card_logo":{"type":"boolean"},"participant_can_be_different_from_billing":{"type":"boolean"},"allow_gift":{"type":"boolean"},"disallow_cart":{"type":"boolean"},"use_separate_page_billing":{"type":"boolean"},"allow_split_payments":{"type":"boolean"},"show_sold_out_prices":{"type":"boolean"},"entrant_name_singular":{"type":"string"},"entrant_name_plural":{"type":"string"},"max_entrants":{"type":"integer"},"max_entrants_per_purchase":{"type":"integer"},"prevent_downloads":{"type":"boolean"},"prevent_downloads_during_refund_period":{"type":"boolean"},"download_limit_count":{"type":"integer","readOnly":true},"download_limit_days":{"type":"integer"},"self_refunds":{"type":"boolean"},"refund_period_days":{"type":"integer"},"allow_upgrade":{"type":"boolean"},"allow_downgrade":{"type":"boolean"},"allow_cancellation":{"type":"boolean"},"pause_enabled":{"type":"boolean"},"paused_participants_keep_access":{"type":"boolean"},"suggest_downgrade_on_cancel":{"type":"boolean"},"choice_menu_id":{"type":"integer"},"create_user_records_automatically":{"type":"boolean"},"show_repurchase_warning":{"type":"boolean"},"credit_quantity":{"type":"number"},"default_currency_code":{"type":"string"},"hide_account_default_currency":{"type":"boolean"},"google_analytics_id":{"type":"string"},"custom_tracking_code":{"type":"string"},"checkout_tracking_code":{"type":"string"},"freebie_token":{"type":"string","readOnly":true},"purchases_count":{"type":"integer","readOnly":true},"attachments_count":{"type":"integer","readOnly":true},"card_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"card_image_id":{"type":"integer"},"order_form_image":{"$ref":"#/components/schemas/Asset","readOnly":true},"order_form_image_id":{"type":"integer"},"sales_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"sales_page_id":{"type":"integer"},"sales_funnel":{"$ref":"#/components/schemas/Funnel","readOnly":true},"sales_funnel_id":{"type":"integer"},"optin_list":{"$ref":"#/components/schemas/List","readOnly":true},"optin_list_id":{"type":"integer"},"sold_out_list":{"$ref":"#/components/schemas/List","readOnly":true},"sold_out_list_id":{"type":"integer"},"credit":{"$ref":"#/components/schemas/Credit","readOnly":true},"credit_id":{"type":"integer"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Price"},"readOnly":true},"price_ids":{"type":"array","items":{"type":"integer"}},"variants":{"type":"array","items":{"$ref":"#/components/schemas/ProductVariant"},"readOnly":true},"variant_ids":{"type":"array","items":{"type":"integer"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"readOnly":true},"attachment_ids":{"type":"array","items":{"type":"integer"}},"upsells":{"type":"array","items":{"$ref":"#/components/schemas/Upsell"},"readOnly":true},"upsell_ids":{"type":"array","items":{"type":"integer"}},"offers":{"type":"array","items":{"$ref":"#/components/schemas/Offer"},"readOnly":true},"offer_ids":{"type":"array","items":{"type":"integer"}},"order_bumps":{"type":"array","items":{"$ref":"#/components/schemas/OrderBump"},"readOnly":true},"order_bump_ids":{"type":"array","items":{"type":"integer"}},"auto_responses":{"type":"array","items":{"$ref":"#/components/schemas/AutoResponse"},"readOnly":true},"auto_response_ids":{"type":"array","items":{"type":"integer"}},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"readOnly":true},"trigger_ids":{"type":"array","items":{"type":"integer"}},"split_tests":{"type":"array","items":{"$ref":"#/components/schemas/SplitTest"},"readOnly":true},"split_test_ids":{"type":"array","items":{"type":"integer"}},"landing_pages":{"type":"array","items":{"$ref":"#/components/schemas/LandingPage"},"readOnly":true},"landing_page_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["name","internal_name"]},"ProductCategory":{"type":"object"},"ProductOptional":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"}},"credit_expiration_unit":{"type":"string"},"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"internal_name":{"type":"string"},"subtitle":{"type":"string"},"summary":{"type":"string","description":"HTML content from a WYSIWYG editor"},"short_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"long_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"listing_type":{"type":"string"},"sales_page_type":{"type":"string","enum":["catalog","landing_page","external","funnel"]},"product_type":{"type":"string","enum":["normal","credit"]},"tax_strategy_event_type":{"type":"string","enum":["public","private","online","none"]},"thank_you_page_behavior":{"type":"string","enum":["thank_you_page","redirect_url","redirect_content"]},"receipt_notifications":{"type":"string"},"sales_page_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"terms_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"welcome_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"sold_out_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"sales_start_at":{"type":"string","format":"date-time"},"sales_end_at":{"type":"string","format":"date-time"},"course_starts_at":{"type":"string","format":"date-time"},"position":{"type":"integer"},"show_in_admin":{"type":"boolean"},"thank_you_page_text":{"type":"string","description":"HTML content from a WYSIWYG editor"},"text_for_invoice":{"type":"string","description":"HTML content from a WYSIWYG editor"},"subscription_notification_extra_text":{"type":"string","description":"HTML content from a WYSIWYG editor"},"broadcast_subject_prefix":{"type":"string"},"broadcast_footer":{"type":"string"},"gdpr_consent_message":{"type":"string"},"use_custom_gdpr_consent_message":{"type":"boolean"},"disable_gdpr_consent":{"type":"boolean"},"sender_name":{"type":"string"},"sender_email":{"type":"string","format":"email"},"reply_to":{"type":"string"},"send_login_email":{"type":"boolean"},"optin_type":{"type":"string","enum":["default","custom","none"]},"optin_label":{"type":"string"},"optin_sublabel":{"type":"string"},"hide_optin":{"type":"boolean"},"optin_pre_checked":{"type":"boolean"},"show_incl_tax":{"type":"boolean"},"tax_exempt":{"type":"boolean"},"vat_no_required":{"type":"boolean"},"dk_youth_vat_rule":{"type":"boolean"},"order_form_top":{"type":"string","description":"HTML content from a WYSIWYG editor"},"order_form_bottom":{"type":"string","description":"HTML content from a WYSIWYG editor"},"order_form_sidebar":{"type":"string","description":"HTML content from a WYSIWYG editor"},"sold_out_message":{"type":"string","description":"HTML content from a WYSIWYG editor"},"ask_for_billing_address":{"type":"boolean"},"ask_for_company_info":{"type":"boolean"},"ask_for_coupon_code":{"type":"boolean"},"billing_address_required":{"type":"boolean"},"order_form_hide_card_logo":{"type":"boolean"},"participant_can_be_different_from_billing":{"type":"boolean"},"allow_gift":{"type":"boolean"},"disallow_cart":{"type":"boolean"},"use_separate_page_billing":{"type":"boolean"},"allow_split_payments":{"type":"boolean"},"show_sold_out_prices":{"type":"boolean"},"entrant_name_singular":{"type":"string"},"entrant_name_plural":{"type":"string"},"max_entrants":{"type":"integer"},"max_entrants_per_purchase":{"type":"integer"},"prevent_downloads":{"type":"boolean"},"prevent_downloads_during_refund_period":{"type":"boolean"},"download_limit_days":{"type":"integer"},"self_refunds":{"type":"boolean"},"refund_period_days":{"type":"integer"},"allow_upgrade":{"type":"boolean"},"allow_downgrade":{"type":"boolean"},"allow_cancellation":{"type":"boolean"},"pause_enabled":{"type":"boolean"},"paused_participants_keep_access":{"type":"boolean"},"suggest_downgrade_on_cancel":{"type":"boolean"},"choice_menu_id":{"type":"integer"},"create_user_records_automatically":{"type":"boolean"},"show_repurchase_warning":{"type":"boolean"},"credit_quantity":{"type":"number"},"default_currency_code":{"type":"string"},"hide_account_default_currency":{"type":"boolean"},"google_analytics_id":{"type":"string"},"custom_tracking_code":{"type":"string"},"checkout_tracking_code":{"type":"string"},"card_image_id":{"type":"integer"},"order_form_image_id":{"type":"integer"},"sales_page_id":{"type":"integer"},"sales_funnel_id":{"type":"integer"},"optin_list_id":{"type":"integer"},"sold_out_list_id":{"type":"integer"},"credit_id":{"type":"integer"},"price_ids":{"type":"array","items":{"type":"integer"}},"variant_ids":{"type":"array","items":{"type":"integer"}},"attachment_ids":{"type":"array","items":{"type":"integer"}},"upsell_ids":{"type":"array","items":{"type":"integer"}},"offer_ids":{"type":"array","items":{"type":"integer"}},"order_bump_ids":{"type":"array","items":{"type":"integer"}},"auto_response_ids":{"type":"array","items":{"type":"integer"}},"trigger_ids":{"type":"array","items":{"type":"integer"}},"split_test_ids":{"type":"array","items":{"type":"integer"}},"landing_page_ids":{"type":"array","items":{"type":"integer"}}}},"ProductVariant":{"type":"object","properties":{"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"name":{"type":"string"},"position":{"type":"integer"},"prices":{"type":"array","items":{"$ref":"#/components/schemas/Price"},"readOnly":true},"price_ids":{"type":"array","items":{"type":"integer"}},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"readOnly":true},"trigger_ids":{"type":"array","items":{"type":"integer"}},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"readOnly":true},"attachment_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["product_id","name","created_at","updated_at"]},"ProductVariantOptional":{"type":"object","properties":{"name":{"type":"string"},"position":{"type":"integer"},"price_ids":{"type":"array","items":{"type":"integer"}},"trigger_ids":{"type":"array","items":{"type":"integer"}},"attachment_ids":{"type":"array","items":{"type":"integer"}}}},"Purchase":{"type":"object","properties":{"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"state":{"type":"string"},"price":{"$ref":"#/components/schemas/Price","readOnly":true},"price_id":{"type":"integer"},"email":{"type":"string","format":"email"},"first_names":{"type":"string"},"last_name":{"type":"string"},"country_code":{"type":"string"},"ip_address":{"type":"string"},"purchased_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"received_price_cents":{"type":"integer"},"received_tax_cents":{"type":"integer"},"received_total_cents":{"type":"integer"},"currency_code":{"type":"string"},"active":{"type":"boolean"},"freebie":{"type":"boolean"},"upsold":{"type":"boolean"},"discount_type":{"type":"string","enum":["none","percent","cents"]},"refunded_at":{"type":"string","format":"date-time","readOnly":true},"canceled_at":{"type":"string","format":"date-time","readOnly":true},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_adgroup":{"type":"string"},"utm_content":{"type":"string"},"utm_keyword":{"type":"string"},"utm_term":{"type":"string"},"track":{"type":"string"},"affiliate":{"$ref":"#/components/schemas/Affiliate","readOnly":true},"affiliate_id":{"type":"integer"},"coupon":{"$ref":"#/components/schemas/Coupon","readOnly":true},"coupon_id":{"type":"integer"},"parent_purchase":{"$ref":"#/components/schemas/Purchase","readOnly":true},"parent_purchase_id":{"type":"integer"},"paused_for_count":{"type":"integer"},"paused_for_unit":{"type":"string"},"token":{"type":"string","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["product","currency_code"]},"RelativeDateFilter":{"type":"object","properties":{"date_comparison":{"type":"string","enum":["","blank","not_blank","before","after","relative_after","relative_before"]},"date":{"type":"string","format":"date","description":"Only when date_comparison is after/before"},"period":{"type":"number","description":"Only when date_comparison is relative_before/relative_after"},"units":{"type":"string","enum":["days","weeks","months","years"],"description":"Only when date_comparison is relative_before/relative_after"}}},"Route":{"type":"object"},"SchedulingLink":{"type":"object","properties":{"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"owner":{"$ref":"#/components/schemas/Administratorship","readOnly":true},"owner_id":{"type":"integer"},"name":{"type":"string"},"internal_name":{"type":"string"},"slug":{"type":"string"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"link_type":{"type":"string","enum":["individual","master"],"description":"Individual links have a single owner; master links pool availability from multiple child links."},"master_type":{"type":"string","enum":["round_robin","collective"],"description":"Only meaningful for master links. Round-robin auto-assigns bookings to an available child link; collective adds all children as attendees on slots where everyone is free."},"availability":{"$ref":"#/components/schemas/Availability"},"availability_id":{"type":"integer"},"calendar":{"$ref":"#/components/schemas/Calendar","readOnly":true},"calendar_id":{"type":"integer"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"product_variant":{"$ref":"#/components/schemas/ProductVariant","readOnly":true},"product_variant_id":{"type":"integer"},"zoom_integration":{"$ref":"#/components/schemas/Integrations::Zoom","readOnly":true},"zoom_integration_id":{"type":"integer"},"asset":{"$ref":"#/components/schemas/Asset","readOnly":true},"asset_id":{"type":"integer"},"primary_child_link":{"$ref":"#/components/schemas/SchedulingLink","readOnly":true,"description":"On collective master links, this is the child link whose owner is the organizer of booked events. Must be one of the children. On round-robin and individual links, this is auto-managed."},"primary_child_link_id":{"type":"integer","description":"On collective master links, this is the child link whose owner is the organizer of booked events. Must be one of the children. On round-robin and individual links, this is auto-managed."},"location_type":{"type":"string","enum":["none","zoom","url","google_meet"]},"location_value":{"type":"string"},"default_view":{"type":"string","enum":["weekly","monthly"]},"scheduling_interval":{"type":"integer","description":"Minutes between bookable slots. One of 15, 30, 60."},"duration":{"type":"integer","description":"Length of each booking in minutes."},"buffer_before_event_minutes":{"type":"integer"},"buffer_after_event_minutes":{"type":"integer"},"min_notice_minutes":{"type":"integer"},"limit_future_booking_days":{"type":"integer"},"max_per_day":{"type":"integer"},"max_per_week":{"type":"integer"},"max_per_month":{"type":"integer"},"max_upcoming_by_customer":{"type":"integer"},"max_total_by_customer":{"type":"integer"},"all_time_limit_message":{"type":"string"},"all_time_limit_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"form_title":{"type":"string"},"event_title_template":{"type":"string"},"booking_success_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"event_description_template":{"type":"string","description":"HTML content from a WYSIWYG editor"},"append_custom_fields_on_event_description":{"type":"boolean"},"rescheduling_policy":{"type":"string","description":"One of \"allow\", \"disallow\", or (for master links) \"allow_master\"."},"rescheduling_notes":{"type":"string","description":"HTML content from a WYSIWYG editor"},"change_period_minutes":{"type":"integer"},"change_reason_mandatory":{"type":"boolean"},"instructions_title":{"type":"string"},"instructions_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"instructions_asset":{"$ref":"#/components/schemas/Asset","readOnly":true,"description":"Optional image, video, or file shown on the after-booking confirmation screen alongside instructions_title and instructions_description."},"instructions_asset_id":{"type":"integer","description":"Optional image, video, or file shown on the after-booking confirmation screen alongside instructions_title and instructions_description."},"meta_conversion_event":{"type":"string","description":"Facebook/Meta Pixel event name fired on successful booking. Common values: Schedule, Lead, SubmitApplication, CompleteRegistration, Contact."},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["owner","owner_id","name","internal_name","slug","availability","created_at","updated_at"]},"SchedulingLinkOptional":{"type":"object","properties":{"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"internal_name":{"type":"string"},"slug":{"type":"string"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"availability":{"$ref":"#/components/schemas/Availability"},"availability_id":{"type":"integer"},"calendar_id":{"type":"integer"},"product_id":{"type":"integer"},"product_variant_id":{"type":"integer"},"zoom_integration_id":{"type":"integer"},"asset_id":{"type":"integer"},"primary_child_link_id":{"type":"integer","description":"On collective master links, this is the child link whose owner is the organizer of booked events. Must be one of the children. On round-robin and individual links, this is auto-managed."},"location_type":{"type":"string","enum":["none","zoom","url","google_meet"]},"location_value":{"type":"string"},"default_view":{"type":"string","enum":["weekly","monthly"]},"scheduling_interval":{"type":"integer","description":"Minutes between bookable slots. One of 15, 30, 60."},"duration":{"type":"integer","description":"Length of each booking in minutes."},"buffer_before_event_minutes":{"type":"integer"},"buffer_after_event_minutes":{"type":"integer"},"min_notice_minutes":{"type":"integer"},"limit_future_booking_days":{"type":"integer"},"max_per_day":{"type":"integer"},"max_per_week":{"type":"integer"},"max_per_month":{"type":"integer"},"max_upcoming_by_customer":{"type":"integer"},"max_total_by_customer":{"type":"integer"},"all_time_limit_message":{"type":"string"},"all_time_limit_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"form_title":{"type":"string"},"event_title_template":{"type":"string"},"booking_success_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"event_description_template":{"type":"string","description":"HTML content from a WYSIWYG editor"},"append_custom_fields_on_event_description":{"type":"boolean"},"rescheduling_policy":{"type":"string","description":"One of \"allow\", \"disallow\", or (for master links) \"allow_master\"."},"rescheduling_notes":{"type":"string","description":"HTML content from a WYSIWYG editor"},"change_period_minutes":{"type":"integer"},"change_reason_mandatory":{"type":"boolean"},"instructions_title":{"type":"string"},"instructions_description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"instructions_asset_id":{"type":"integer","description":"Optional image, video, or file shown on the after-booking confirmation screen alongside instructions_title and instructions_description."},"meta_conversion_event":{"type":"string","description":"Facebook/Meta Pixel event name fired on successful booking. Common values: Schedule, Lead, SubmitApplication, CompleteRegistration, Contact."}}},"Segment":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"members_count":{"type":"integer","readOnly":true},"calculated_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}}},"Site":{"type":"object","properties":{"blog_index_builder_doc_id":{"type":"integer","readOnly":true,"description":"ID of the blog_index BuilderDoc owned by this Site."},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"canonical_subdomain":{"type":"string"},"canonical_domain":{"type":"string"},"locale":{"type":"string"},"access":{"type":"string"},"enabled":{"type":"boolean"},"url":{"type":"string","format":"uri","readOnly":true,"description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"blog_enabled":{"type":"boolean"},"blog_title":{"type":"string"},"force_new_experience":{"type":"boolean"},"exclude_courses_from_new_content":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["title","internal_name","meta_title","created_at","updated_at"]},"SiteGroup":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}}}},"SiteOptional":{"type":"object","properties":{"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"meta_title":{"type":"string"},"meta_description":{"type":"string"},"canonical_subdomain":{"type":"string"},"canonical_domain":{"type":"string"},"locale":{"type":"string"},"access":{"type":"string"},"enabled":{"type":"boolean"},"blog_enabled":{"type":"boolean"},"blog_title":{"type":"string"},"force_new_experience":{"type":"boolean"},"exclude_courses_from_new_content":{"type":"boolean"}}},"SplitTest":{"type":"object"},"Step":{"type":"object","properties":{"wait_count":{"type":"integer"},"wait_unit":{"type":"string"},"delta_count":{"type":"integer"},"delta_unit":{"type":"string"},"automation":{"$ref":"#/components/schemas/Automation","readOnly":true},"automation_id":{"type":"integer"},"step_type":{"type":"string","description":"Type of step. action = run an Action. wait = pause for a duration/event. goto = jump to another step. stop = end the flow."},"name":{"type":"string"},"notes":{"type":"string"},"enabled":{"type":"boolean"},"always_run":{"type":"boolean"},"skip_if_wait_exceeded":{"type":"boolean"},"action":{"$ref":"#/components/schemas/Action","readOnly":true,"description":"The Action this step performs (only when step_type is action). Read-only object reference; set via action_id."},"action_id":{"type":"integer","description":"The Action this step performs (only when step_type is action). Read-only object reference; set via action_id."},"parent":{"$ref":"#/components/schemas/Step","readOnly":true,"description":"Previous step in the linear chain. nil = first step in the automation."},"parent_id":{"type":"integer","description":"Previous step in the linear chain. nil = first step in the automation."},"goto_step":{"$ref":"#/components/schemas/Step","readOnly":true,"description":"Target step when step_type is goto."},"goto_step_id":{"type":"integer","description":"Target step when step_type is goto."},"field":{"$ref":"#/components/schemas/Field","readOnly":true,"description":"Custom field to read when wait_type is 'field'."},"field_id":{"type":"integer","description":"Custom field to read when wait_type is 'field'."},"countdown_timer":{"$ref":"#/components/schemas/CountdownTimer","readOnly":true,"description":"Countdown timer to wait on when wait_type is 'countdown_timer'."},"countdown_timer_id":{"type":"integer","description":"Countdown timer to wait on when wait_type is 'countdown_timer'."},"wait_type":{"type":"string","description":"How the wait step computes its end time. Only applies when step_type is wait."},"delta_sign":{"type":"integer","description":"Sign for the delta offset. -1 = before the wait target, 1 = after. Only applies to relative wait types (field, course_start, period_ends, event_start, event_end, countdown_timer)."},"wait_for_day":{"type":"string","description":"Day-of-week constraint. 'any', 'weekday', 'weekend', or a day name."},"wait_for_day_of_month":{"type":"integer","description":"Specific day of the month to wait for. 1-31, or negative for last/second-to-last."},"wait_for_time_min":{"type":"integer","description":"Earliest minute-of-day (0-1439) for the wait to fire."},"wait_for_time_max":{"type":"integer","description":"Latest minute-of-day (0-1439) for the wait to fire."},"wait_time_zone":{"type":"string","description":"Time zone to use for wait timing. 'account' or 'contact'."},"wait_until_time":{"type":"string","format":"date-time","description":"Specific datetime to wait until. Only applies when wait_type is until_time."},"wait_until_time_contact":{"type":"string","description":"Specific time-of-day to wait until, evaluated in the contact's time zone. Only applies when wait_type is until_time_contact."},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["automation_id","created_at","updated_at"]},"StepOptional":{"type":"object","properties":{"wait_count":{"type":"integer"},"wait_unit":{"type":"string"},"delta_count":{"type":"integer"},"delta_unit":{"type":"string"},"name":{"type":"string"},"notes":{"type":"string"},"enabled":{"type":"boolean"},"always_run":{"type":"boolean"},"skip_if_wait_exceeded":{"type":"boolean"},"action_id":{"type":"integer","description":"The Action this step performs (only when step_type is action). Read-only object reference; set via action_id."},"parent_id":{"type":"integer","description":"Previous step in the linear chain. nil = first step in the automation."},"goto_step_id":{"type":"integer","description":"Target step when step_type is goto."},"field_id":{"type":"integer","description":"Custom field to read when wait_type is 'field'."},"countdown_timer_id":{"type":"integer","description":"Countdown timer to wait on when wait_type is 'countdown_timer'."},"wait_type":{"type":"string","description":"How the wait step computes its end time. Only applies when step_type is wait."},"delta_sign":{"type":"integer","description":"Sign for the delta offset. -1 = before the wait target, 1 = after. Only applies to relative wait types (field, course_start, period_ends, event_start, event_end, countdown_timer)."},"wait_for_day":{"type":"string","description":"Day-of-week constraint. 'any', 'weekday', 'weekend', or a day name."},"wait_for_day_of_month":{"type":"integer","description":"Specific day of the month to wait for. 1-31, or negative for last/second-to-last."},"wait_for_time_min":{"type":"integer","description":"Earliest minute-of-day (0-1439) for the wait to fire."},"wait_for_time_max":{"type":"integer","description":"Latest minute-of-day (0-1439) for the wait to fire."},"wait_time_zone":{"type":"string","description":"Time zone to use for wait timing. 'account' or 'contact'."},"wait_until_time":{"type":"string","format":"date-time","description":"Specific datetime to wait until. Only applies when wait_type is until_time."},"wait_until_time_contact":{"type":"string","description":"Specific time-of-day to wait until, evaluated in the contact's time zone. Only applies when wait_type is until_time_contact."}}},"StringFilter":{"type":"object","properties":{"op":{"type":"string","enum":["contains","not_contain","starts_with","ends_with","equals","not_equal","blank","not_blank"]},"value":{"type":"string","description":"Only when op is contains/not_contain/starts_with/ends_with/equals/not_equal"}}},"StyleGuide":{"type":"object","properties":{"content_builder_doc_id":{"type":"integer","readOnly":true,"description":"ID of the content BuilderDoc owned by this StyleGuide."},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}}}},"Subscription":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"list":{"$ref":"#/components/schemas/List","readOnly":true},"list_id":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"affiliate":{"$ref":"#/components/schemas/Affiliate","readOnly":true},"affiliate_id":{"type":"integer"},"landing_page":{"$ref":"#/components/schemas/LandingPage","readOnly":true},"landing_page_id":{"type":"integer"},"funnel_step":{"$ref":"#/components/schemas/FunnelStep","readOnly":true},"funnel_step_id":{"type":"integer"},"active":{"type":"boolean"},"confirmed":{"type":"boolean"},"skip_auto_responses":{"type":"boolean"},"first_activated_at":{"type":"string","format":"date-time","readOnly":true},"confirmed_at":{"type":"string","format":"date-time","readOnly":true},"unsubscribed_at":{"type":"string","format":"date-time","readOnly":true},"suspended_at":{"type":"string","format":"date-time","readOnly":true},"auto_responder_start_at":{"type":"string","format":"date-time","readOnly":true},"auto_responder_paused_at":{"type":"string","format":"date-time","readOnly":true},"auto_responder_reset_at":{"type":"string","format":"date-time","readOnly":true},"next_auto_response_check_at":{"type":"string","format":"date-time","readOnly":true},"confirmation_request_sent_at":{"type":"string","format":"date-time","readOnly":true},"confirmation_request_sent_count":{"type":"integer","readOnly":true},"ref":{"type":"string"},"track":{"type":"string"},"ip_address":{"type":"string"},"referrer":{"type":"string"},"suspend_reason":{"type":"string"},"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_content":{"type":"string"},"utm_term":{"type":"string"},"utm_adgroup":{"type":"string"},"utm_keyword":{"type":"string"},"status":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["token","list","list_id","customer","customer_id"]},"Survey":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"form_fields":{"type":"array","items":{"$ref":"#/components/schemas/FormField"},"readOnly":true},"form_field_ids":{"type":"array","items":{"type":"integer"}},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"submit_button_label":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"confirmation_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"responses_count":{"type":"integer","readOnly":true},"response_notification_emails":{"type":"string"},"success_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"custom_tracking_code":{"type":"string"},"custom_tracking_code_for_body":{"type":"string"},"confirmation_option":{"type":"string","enum":["thank_you","redirect"]},"confirmation_title":{"type":"string"},"presentation_mode":{"type":"string","enum":["single_page","multi_page"]},"show_question_numbers":{"type":"boolean"},"meta_conversion_event":{"type":"string"},"responses":{"type":"array","items":{"$ref":"#/components/schemas/SurveyResponse"},"readOnly":true},"response_ids":{"type":"array","items":{"type":"integer"}},"triggers":{"type":"array","items":{"$ref":"#/components/schemas/Trigger"},"readOnly":true},"trigger_ids":{"type":"array","items":{"type":"integer"}},"funnel_steps":{"type":"array","items":{"$ref":"#/components/schemas/FunnelStep"},"readOnly":true},"funnel_step_ids":{"type":"array","items":{"type":"integer"}},"funnels":{"type":"array","items":{"$ref":"#/components/schemas/Funnel"},"readOnly":true},"funnel_ids":{"type":"array","items":{"type":"integer"}},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["title","internal_name","created_at","updated_at"]},"SurveyOptional":{"type":"object","properties":{"form_field_ids":{"type":"array","items":{"type":"integer"}},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"internal_name":{"type":"string"},"submit_button_label":{"type":"string"},"description":{"type":"string","description":"HTML content from a WYSIWYG editor"},"confirmation_body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"active":{"type":"boolean"},"show_in_admin":{"type":"boolean"},"response_notification_emails":{"type":"string"},"success_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"custom_tracking_code":{"type":"string"},"custom_tracking_code_for_body":{"type":"string"},"confirmation_option":{"type":"string","enum":["thank_you","redirect"]},"confirmation_title":{"type":"string"},"presentation_mode":{"type":"string","enum":["single_page","multi_page"]},"show_question_numbers":{"type":"boolean"},"meta_conversion_event":{"type":"string"},"response_ids":{"type":"array","items":{"type":"integer"}},"trigger_ids":{"type":"array","items":{"type":"integer"}},"funnel_step_ids":{"type":"array","items":{"type":"integer"}},"funnel_ids":{"type":"array","items":{"type":"integer"}}}},"SurveyResponse":{"type":"object","properties":{"field_values":{"type":"array","items":{"$ref":"#/components/schemas/FieldValue"},"readOnly":true},"field_value_ids":{"type":"array","items":{"type":"integer"}},"token":{"type":"string","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"survey":{"$ref":"#/components/schemas/Survey","readOnly":true},"survey_id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"referrer":{"type":"string"},"viewed_at":{"type":"string","format":"date-time","readOnly":true},"started_at":{"type":"string","format":"date-time","readOnly":true},"score":{"type":"integer"},"spam":{"type":"boolean"}},"required":["created_at","updated_at","survey_id"]},"SurveyResponseOptional":{"type":"object","properties":{"field_value_ids":{"type":"array","items":{"type":"integer"}},"customer_id":{"type":"integer"},"name":{"type":"string"},"email":{"type":"string","format":"email"},"referrer":{"type":"string"},"score":{"type":"integer"},"spam":{"type":"boolean"}}},"Tag":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"owner":{"$ref":"#/components/schemas/User","readOnly":true},"owner_id":{"type":"integer"},"undeleted_customers_count":{"type":"integer","readOnly":true},"last_tagging_at":{"type":"string","format":"date-time","readOnly":true},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["token","name","created_at","updated_at"]},"TagOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"name":{"type":"string"},"description":{"type":"string"},"color":{"type":"string"},"owner_id":{"type":"integer"}}},"Tagging":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"tag":{"$ref":"#/components/schemas/Tag","readOnly":true},"tag_id":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"created_at":{"type":"string","format":"date-time","readOnly":true}},"required":["token","tag_id","customer_id","created_at"]},"Testimonial":{"type":"object","properties":{"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"author_name":{"type":"string"},"author_email":{"type":"string","format":"email"},"author_title":{"type":"string"},"author_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"rating":{"type":"integer"},"published":{"type":"boolean"},"anonymous":{"type":"boolean"},"source":{"type":"string"},"permission_given_at":{"type":"string","format":"date-time"},"product":{"$ref":"#/components/schemas/Product","readOnly":true},"product_id":{"type":"integer"},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"bot":{"$ref":"#/components/schemas/Bot","readOnly":true},"bot_id":{"type":"integer"},"attachments":{"type":"array","items":{"$ref":"#/components/schemas/Attachment"},"readOnly":true},"attachment_ids":{"type":"array","items":{"type":"integer"}}},"required":["created_at","updated_at","author_name"]},"TestimonialOptional":{"type":"object","properties":{"label_ids":{"type":"array","items":{"type":"integer"}},"title":{"type":"string"},"body":{"type":"string","description":"HTML content from a WYSIWYG editor"},"author_name":{"type":"string"},"author_email":{"type":"string","format":"email"},"author_title":{"type":"string"},"author_url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"rating":{"type":"integer"},"published":{"type":"boolean"},"anonymous":{"type":"boolean"},"source":{"type":"string"},"permission_given_at":{"type":"string","format":"date-time"},"product_id":{"type":"integer"},"customer_id":{"type":"integer"},"bot_id":{"type":"integer"},"attachment_ids":{"type":"array","items":{"type":"integer"}}}},"Theme":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}}}},"Ticket":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"facet_values":{"type":"array","items":{"$ref":"#/components/schemas/FacetValue"},"readOnly":true},"facet_value_ids":{"type":"array","items":{"type":"integer"}},"customer":{"$ref":"#/components/schemas/Customer","readOnly":true},"customer_id":{"type":"integer"},"subject":{"type":"string"},"body":{"type":"string"},"url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"submitter":{"$ref":"#/components/schemas/User","readOnly":true},"submitter_id":{"type":"integer"},"assignee":{"$ref":"#/components/schemas/User","readOnly":true},"assignee_id":{"type":"integer"},"pipeline_stage":{"$ref":"#/components/schemas/PipelineStage","readOnly":true},"pipeline_stage_id":{"type":"integer"},"personal_angel":{"type":"boolean"},"super_urgent":{"type":"boolean"},"created_at":{"type":"string","format":"date-time","readOnly":true},"updated_at":{"type":"string","format":"date-time","readOnly":true}},"required":["subject","pipeline_stage","created_at","updated_at"]},"TicketOptional":{"type":"object","properties":{"facet_value_ids":{"type":"array","items":{"type":"integer"}},"customer_id":{"type":"integer"},"subject":{"type":"string"},"body":{"type":"string"},"url":{"type":"string","format":"uri","description":"Must be an absolute URL including scheme (e.g. https://example.com)"},"submitter_id":{"type":"integer"},"assignee_id":{"type":"integer"},"pipeline_stage_id":{"type":"integer"},"personal_angel":{"type":"boolean"},"super_urgent":{"type":"boolean"}}},"Trigger":{"type":"object","properties":{"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}},"duration_count":{"type":"integer"},"duration_unit":{"type":"string"}}},"Upsell":{"type":"object","properties":{"token":{"type":"string","readOnly":true}}},"User":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"first_names":{"type":"string"},"last_name":{"type":"string"},"email":{"type":"string","format":"email"},"username":{"type":"string"}},"required":["email","username"]},"Worksheet":{"type":"object","properties":{"token":{"type":"string","readOnly":true},"labels":{"type":"array","items":{"$ref":"#/components/schemas/Label"},"readOnly":true},"label_ids":{"type":"array","items":{"type":"integer"}}}}}}}