{"openapi":"3.1.0","info":{"title":"Laravel API","version":"1.0.0","description":"Every endpoint returns `{ \"data\": \u2026 }` on success and `{ \"error\": { \"code\", \"message\" } }` on failure.\n\nAuthenticate with a bearer token (OAuth or personal access token) or an `X-Api-Key` header.\nMachine credentials are scoped; each operation lists the scope it needs.\n\nLists accept `cursor` and `per_page`. Pass the `next_cursor` from `meta` to page forward;\na null `next_cursor` means there are no more results. Offset pagination is still accepted\non older endpoints but is not recommended \u2014 it skips and repeats rows when the underlying\ndata changes between pages.\n\nSend `Idempotency-Key` on any POST you might retry. The stored response is replayed rather\nthan the action being repeated."},"servers":[{"url":"https:\/\/whatsapp.qaffplus.sa\/api\/v1","description":"Production"}],"security":[{"bearerAuth":[]},{"apiKey":[]}],"tags":[{"name":"ai","description":"Ai"},{"name":"analytics","description":"Analytics"},{"name":"appointments","description":"Appointments"},{"name":"bot-flows","description":"Bot Flows"},{"name":"calendars","description":"Calendars"},{"name":"campaigns","description":"Campaigns"},{"name":"channels","description":"Channels"},{"name":"chat-widgets","description":"Chat Widgets"},{"name":"contacts","description":"Contacts"},{"name":"conversations","description":"Conversations"},{"name":"custom-fields","description":"Custom Fields"},{"name":"dashboards","description":"Dashboards"},{"name":"deals","description":"Deals"},{"name":"filters","description":"Filters"},{"name":"forms","description":"Forms"},{"name":"funnels","description":"Funnels"},{"name":"invoices","description":"Invoices"},{"name":"leads","description":"Leads"},{"name":"me","description":"Me"},{"name":"opportunities","description":"Opportunities"},{"name":"payments","description":"Payments"},{"name":"pipelines","description":"Pipelines"},{"name":"profile","description":"Profile"},{"name":"record-types","description":"Record Types"},{"name":"records","description":"Records"},{"name":"report-schedules","description":"Report Schedules"},{"name":"scheduling","description":"Scheduling"},{"name":"sites","description":"Sites"},{"name":"tags","description":"Tags"},{"name":"templates","description":"Templates"},{"name":"web-forms","description":"Web Forms"},{"name":"webhooks","description":"Webhooks"},{"name":"whatsapp","description":"Whatsapp"},{"name":"workspaces","description":"Workspaces"}],"paths":{"\/ai\/agents":{"get":{"tags":["ai"],"summary":"Ai Agents Index","operationId":"aiAgentsIndex","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["ai"],"summary":"Ai Agents Store","operationId":"aiAgentsStore","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}":{"get":{"tags":["ai"],"summary":"Ai Agents Show","operationId":"aiAgentsShow","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["ai"],"summary":"Ai Agents Update","operationId":"aiAgentsUpdate","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["ai"],"summary":"Ai Agents Destroy","operationId":"aiAgentsDestroy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/purge-cache":{"post":{"tags":["ai"],"summary":"Ai Agents Purge Cache","operationId":"aiAgentsPurgeCache","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/sandbox":{"post":{"tags":["ai"],"summary":"Ai Agents Sandbox","operationId":"aiAgentsSandbox","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/status":{"post":{"tags":["ai"],"summary":"Ai Agents Status","operationId":"aiAgentsStatus","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/tests":{"get":{"tags":["ai"],"summary":"Ai Agents Tests","operationId":"aiAgentsTests","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["ai"],"summary":"Ai Agents Tests Store","operationId":"aiAgentsTestsStore","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/tests\/run":{"post":{"tags":["ai"],"summary":"Ai Agents Tests Run","operationId":"aiAgentsTestsRun","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/agents\/{agent}\/tests\/{test}":{"delete":{"tags":["ai"],"summary":"Ai Agents Tests Destroy","operationId":"aiAgentsTestsDestroy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"agent","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"test","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/assistants":{"get":{"tags":["ai"],"summary":"Assistants Index","operationId":"assistantsIndex","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["ai"],"summary":"Assistants Store","operationId":"assistantsStore","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/assistants\/{assistant}":{"get":{"tags":["ai"],"summary":"Assistants Show","operationId":"assistantsShow","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"assistant","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["ai"],"summary":"Assistants Update","operationId":"assistantsUpdate","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"assistant","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["ai"],"summary":"Assistants Update","operationId":"assistantsUpdate","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"assistant","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["ai"],"summary":"Assistants Destroy","operationId":"assistantsDestroy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"assistant","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/auto-reply":{"post":{"tags":["ai"],"summary":"Ai Auto Reply","operationId":"aiAutoReply","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/budget":{"get":{"tags":["ai"],"summary":"Ai Budget","operationId":"aiBudget","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["ai"],"summary":"Ai Budget Set","operationId":"aiBudgetSet","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/cache":{"get":{"tags":["ai"],"summary":"Ai Cache Stats","operationId":"aiCacheStats","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["ai"],"summary":"Ai Cache Flush","operationId":"aiCacheFlush","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/classify":{"post":{"tags":["ai"],"summary":"Ai Classify","operationId":"aiClassify","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/copilot\/copy":{"post":{"tags":["ai"],"summary":"Ai Copilot Copy","operationId":"aiCopilotCopy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/copilot\/rewrite":{"post":{"tags":["ai"],"summary":"Ai Copilot Rewrite","operationId":"aiCopilotRewrite","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/copilot\/{conversation}\/classify":{"post":{"tags":["ai"],"summary":"Ai Copilot Classify","operationId":"aiCopilotClassify","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/copilot\/{conversation}\/suggest":{"post":{"tags":["ai"],"summary":"Ai Copilot Suggest","operationId":"aiCopilotSuggest","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/copilot\/{conversation}\/summarise":{"post":{"tags":["ai"],"summary":"Ai Copilot Summarise","operationId":"aiCopilotSummarise","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/credentials":{"get":{"tags":["ai"],"summary":"Ai Credentials","operationId":"aiCredentials","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["ai"],"summary":"Ai Credentials Store","operationId":"aiCredentialsStore","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/credentials\/{credential}":{"delete":{"tags":["ai"],"summary":"Ai Credentials Destroy","operationId":"aiCredentialsDestroy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"credential","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/dialect":{"post":{"tags":["ai"],"summary":"Ai Dialect","operationId":"aiDialect","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/intent":{"post":{"tags":["ai"],"summary":"Ai Intent","operationId":"aiIntent","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/knowledge":{"get":{"tags":["ai"],"summary":"Ai Knowledge Index","operationId":"aiKnowledgeIndex","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["ai"],"summary":"Ai Knowledge Store","operationId":"aiKnowledgeStore","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/knowledge\/search":{"post":{"tags":["ai"],"summary":"Ai Knowledge Search","operationId":"aiKnowledgeSearch","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/knowledge\/{source}":{"patch":{"tags":["ai"],"summary":"Ai Knowledge Update","operationId":"aiKnowledgeUpdate","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"source","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["ai"],"summary":"Ai Knowledge Destroy","operationId":"aiKnowledgeDestroy","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"source","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/knowledge\/{source}\/reindex":{"post":{"tags":["ai"],"summary":"Ai Knowledge Reindex","operationId":"aiKnowledgeReindex","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"source","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/qualify-lead":{"post":{"tags":["ai"],"summary":"Ai Qualify Lead","operationId":"aiQualifyLead","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/sentiment":{"post":{"tags":["ai"],"summary":"Ai Sentiment","operationId":"aiSentiment","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/suggest":{"post":{"tags":["ai"],"summary":"Ai Suggest","operationId":"aiSuggest","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/summarize":{"post":{"tags":["ai"],"summary":"Ai Summarize","operationId":"aiSummarize","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/transcript-retention":{"put":{"tags":["ai"],"summary":"Ai Retention","operationId":"aiRetention","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/transcripts":{"get":{"tags":["ai"],"summary":"Ai Transcripts","operationId":"aiTranscripts","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/translate":{"post":{"tags":["ai"],"summary":"Ai Translate","operationId":"aiTranslate","security":[{"bearerAuth":["ai.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/ai\/usage":{"get":{"tags":["ai"],"summary":"Ai Usage","operationId":"aiUsage","security":[{"bearerAuth":["ai.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/agents":{"get":{"tags":["analytics"],"summary":"Analytics Agents","operationId":"analyticsAgents","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/attribution":{"get":{"tags":["analytics"],"summary":"Analytics Attribution","operationId":"analyticsAttribution","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/attribution\/{contact}\/journey":{"get":{"tags":["analytics"],"summary":"Analytics Journey","operationId":"analyticsJourney","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/campaigns":{"get":{"tags":["analytics"],"summary":"Analytics Campaigns","operationId":"analyticsCampaigns","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/conversations":{"get":{"tags":["analytics"],"summary":"Analytics Conversations","operationId":"analyticsConversations","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/costs":{"get":{"tags":["analytics"],"summary":"Analytics Costs","operationId":"analyticsCosts","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/export":{"get":{"tags":["analytics"],"summary":"Analytics Export","operationId":"analyticsExport","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/metrics":{"get":{"tags":["analytics"],"summary":"Analytics Metrics","operationId":"analyticsMetrics","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/query":{"get":{"tags":["analytics"],"summary":"Analytics Query","operationId":"analyticsQuery","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["analytics"],"summary":"Analytics Query","operationId":"analyticsQuery","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/revenue":{"get":{"tags":["analytics"],"summary":"Analytics Revenue","operationId":"analyticsRevenue","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/analytics\/send-times":{"get":{"tags":["analytics"],"summary":"Analytics Send Times","operationId":"analyticsSendTimes","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments":{"get":{"tags":["appointments"],"summary":"Appointments Index","operationId":"appointmentsIndex","security":[{"bearerAuth":["appointments.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Appointment"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["appointments"],"summary":"Appointments Store","operationId":"appointmentsStore","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Appointment"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/manage\/{token}":{"get":{"tags":["appointments"],"summary":"Public Appointments Manage","operationId":"publicAppointmentsManage","security":[{"bearerAuth":["appointments.read"]}],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["appointments"],"summary":"Public Appointments Update","operationId":"publicAppointmentsUpdate","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/{appointment}\/cancel":{"post":{"tags":["appointments"],"summary":"Appointments Cancel","operationId":"appointmentsCancel","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"appointment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/{appointment}\/complete":{"post":{"tags":["appointments"],"summary":"Appointments Complete","operationId":"appointmentsComplete","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"appointment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/{appointment}\/confirm":{"post":{"tags":["appointments"],"summary":"Appointments Confirm","operationId":"appointmentsConfirm","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"appointment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/{appointment}\/no-show":{"post":{"tags":["appointments"],"summary":"Appointments No Show","operationId":"appointmentsNoShow","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"appointment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/appointments\/{appointment}\/reschedule":{"post":{"tags":["appointments"],"summary":"Appointments Reschedule","operationId":"appointmentsReschedule","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"appointment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows":{"get":{"tags":["bot-flows"],"summary":"Bot Flows Index","operationId":"botFlowsIndex","security":[{"bearerAuth":["workflows.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["bot-flows"],"summary":"Bot Flows Store","operationId":"botFlowsStore","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/preview":{"post":{"tags":["bot-flows"],"summary":"Bot Flows Preview","operationId":"botFlowsPreview","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/validate":{"post":{"tags":["bot-flows"],"summary":"Bot Flows Validate","operationId":"botFlowsValidate","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/{flow}":{"get":{"tags":["bot-flows"],"summary":"Bot Flows Show","operationId":"botFlowsShow","security":[{"bearerAuth":["workflows.read"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["bot-flows"],"summary":"Bot Flows Update","operationId":"botFlowsUpdate","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/{flow}\/analytics":{"get":{"tags":["bot-flows"],"summary":"Bot Flows Analytics","operationId":"botFlowsAnalytics","security":[{"bearerAuth":["workflows.read"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/{flow}\/draft":{"put":{"tags":["bot-flows"],"summary":"Bot Flows Draft","operationId":"botFlowsDraft","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/{flow}\/publish":{"post":{"tags":["bot-flows"],"summary":"Bot Flows Publish","operationId":"botFlowsPublish","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/bot-flows\/{flow}\/simulate":{"post":{"tags":["bot-flows"],"summary":"Bot Flows Simulate","operationId":"botFlowsSimulate","security":[{"bearerAuth":["workflows.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars":{"get":{"tags":["calendars"],"summary":"Calendars Index","operationId":"calendarsIndex","security":[{"bearerAuth":["calendars.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["calendars"],"summary":"Calendars Store","operationId":"calendarsStore","security":[{"bearerAuth":["calendars.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars\/{calendar}":{"get":{"tags":["calendars"],"summary":"Calendars Show","operationId":"calendarsShow","security":[{"bearerAuth":["calendars.read"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["calendars"],"summary":"Calendars Update","operationId":"calendarsUpdate","security":[{"bearerAuth":["calendars.write"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars\/{calendar}\/hosts":{"post":{"tags":["calendars"],"summary":"Calendars Hosts Store","operationId":"calendarsHostsStore","security":[{"bearerAuth":["calendars.write"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars\/{calendar}\/hosts\/{userId}\/sync":{"post":{"tags":["calendars"],"summary":"Calendars Hosts Sync","operationId":"calendarsHostsSync","security":[{"bearerAuth":["calendars.write"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars\/{calendar}\/meeting-readiness":{"get":{"tags":["calendars"],"summary":"Calendars Meeting Readiness","operationId":"calendarsMeetingReadiness","security":[{"bearerAuth":["calendars.read"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/calendars\/{calendar}\/slots":{"get":{"tags":["calendars"],"summary":"Calendars Slots","operationId":"calendarsSlots","security":[{"bearerAuth":["calendars.read"]}],"parameters":[{"name":"calendar","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns":{"get":{"tags":["campaigns"],"summary":"Campaigns Index","operationId":"campaignsIndex","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["campaigns"],"summary":"Campaigns Store","operationId":"campaignsStore","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}":{"get":{"tags":["campaigns"],"summary":"Campaigns Show","operationId":"campaignsShow","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["campaigns"],"summary":"Campaigns Update","operationId":"campaignsUpdate","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["campaigns"],"summary":"Campaigns Update","operationId":"campaignsUpdate","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["campaigns"],"summary":"Campaigns Destroy","operationId":"campaignsDestroy","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/approve":{"post":{"tags":["campaigns"],"summary":"Campaigns Approve","operationId":"campaignsApprove","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/audience":{"get":{"tags":["campaigns"],"summary":"Campaigns Audience","operationId":"campaignsAudience","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/cancel":{"post":{"tags":["campaigns"],"summary":"Campaigns Cancel","operationId":"campaignsCancel","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/exclusions":{"get":{"tags":["campaigns"],"summary":"Campaigns Exclusions","operationId":"campaignsExclusions","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/pause":{"post":{"tags":["campaigns"],"summary":"Campaigns Pause","operationId":"campaignsPause","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/preflight":{"post":{"tags":["campaigns"],"summary":"Campaigns Preflight","operationId":"campaignsPreflight","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/recipients":{"get":{"tags":["campaigns"],"summary":"Campaigns Recipients","operationId":"campaignsRecipients","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/report":{"get":{"tags":["campaigns"],"summary":"Campaigns Report","operationId":"campaignsReport","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/resume":{"post":{"tags":["campaigns"],"summary":"Campaigns Resume","operationId":"campaignsResume","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/retry-failures":{"post":{"tags":["campaigns"],"summary":"Campaigns Retry","operationId":"campaignsRetry","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/schedule":{"post":{"tags":["campaigns"],"summary":"Campaigns Schedule","operationId":"campaignsSchedule","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/send-times":{"get":{"tags":["campaigns"],"summary":"Campaigns Send Times","operationId":"campaignsSendTimes","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["campaigns"],"summary":"Campaigns Send Times","operationId":"campaignsSendTimes","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/start":{"post":{"tags":["campaigns"],"summary":"Campaigns Start","operationId":"campaignsStart","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/stats":{"get":{"tags":["campaigns"],"summary":"Campaigns Stats","operationId":"campaignsStats","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/campaigns\/{campaign}\/variants":{"get":{"tags":["campaigns"],"summary":"Campaigns Variants","operationId":"campaignsVariants","security":[{"bearerAuth":["campaigns.read"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["campaigns"],"summary":"Campaigns Variants","operationId":"campaignsVariants","security":[{"bearerAuth":["campaigns.write"]}],"parameters":[{"name":"campaign","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/capabilities":{"get":{"tags":["channels"],"summary":"Channels Capabilities","operationId":"channelsCapabilities","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/capabilities\/preview":{"post":{"tags":["channels"],"summary":"Channels Capabilities Preview","operationId":"channelsCapabilitiesPreview","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/cloud\/embedded-signup":{"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/cloud\/embedded-signup","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/cloud\/{account}\/status":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/cloud\/{account}\/status","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"account","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/health":{"get":{"tags":["channels"],"summary":"Channels Health","operationId":"channelsHealth","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/providers":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/providers","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/routing":{"get":{"tags":["channels"],"summary":"Channels Routing","operationId":"channelsRouting","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["channels"],"summary":"Channels Routing Store","operationId":"channelsRoutingStore","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/routing\/{rule}":{"delete":{"tags":["channels"],"summary":"Channels Routing Destroy","operationId":"channelsRoutingDestroy","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"rule","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/facebook\/callback":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/social\/facebook\/callback","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/facebook\/connect":{"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/social\/facebook\/connect","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/facebook\/pages":{"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/social\/facebook\/pages","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/facebook\/redirect":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/social\/facebook\/redirect","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/instagram\/accounts":{"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/social\/instagram\/accounts","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/instagram\/connect":{"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/social\/instagram\/connect","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/{platform}\/oauth\/callback":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/social\/{platform}\/oauth\/callback","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/{platform}\/oauth\/redirect":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/social\/{platform}\/oauth\/redirect","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/channels\/social\/{platform}\/webhook":{"get":{"tags":["channels"],"summary":"GET api\/v1\/channels\/social\/{platform}\/webhook","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["channels"],"summary":"POST api\/v1\/channels\/social\/{platform}\/webhook","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"platform","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/chat-widgets":{"get":{"tags":["chat-widgets"],"summary":"Chat Widgets Index","operationId":"chatWidgetsIndex","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["chat-widgets"],"summary":"Chat Widgets Store","operationId":"chatWidgetsStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/chat-widgets\/{widget}":{"get":{"tags":["chat-widgets"],"summary":"Chat Widgets Show","operationId":"chatWidgetsShow","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["chat-widgets"],"summary":"Chat Widgets Update","operationId":"chatWidgetsUpdate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["chat-widgets"],"summary":"Chat Widgets Update","operationId":"chatWidgetsUpdate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["chat-widgets"],"summary":"Chat Widgets Destroy","operationId":"chatWidgetsDestroy","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/chat-widgets\/{widget}\/report":{"get":{"tags":["chat-widgets"],"summary":"Chat Widgets Report","operationId":"chatWidgetsReport","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts":{"get":{"tags":["contacts"],"summary":"Contacts Index","operationId":"contactsIndex","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Contact"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["contacts"],"summary":"Contacts Store","operationId":"contactsStore","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Contact"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/duplicates":{"get":{"tags":["contacts"],"summary":"Contacts Duplicates","operationId":"contactsDuplicates","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/export":{"get":{"tags":["contacts"],"summary":"Contacts Export","operationId":"contactsExport","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/import":{"post":{"tags":["contacts"],"summary":"Contacts Import","operationId":"contactsImport","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/merge":{"post":{"tags":["contacts"],"summary":"Contacts Merge","operationId":"contactsMerge","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}":{"get":{"tags":["contacts"],"summary":"Contacts Show","operationId":"contactsShow","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Contact"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["contacts"],"summary":"Contacts Update","operationId":"contactsUpdate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Contact"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["contacts"],"summary":"Contacts Update","operationId":"contactsUpdate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Contact"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["contacts"],"summary":"Contacts Destroy","operationId":"contactsDestroy","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/consent":{"get":{"tags":["contacts"],"summary":"Contacts Consent Index","operationId":"contactsConsentIndex","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["contacts"],"summary":"Contacts Consent Grant","operationId":"contactsConsentGrant","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["contacts"],"summary":"Contacts Consent Revoke","operationId":"contactsConsentRevoke","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/merge":{"post":{"tags":["contacts"],"summary":"Contacts Merge","operationId":"contactsMerge","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/merges":{"get":{"tags":["contacts"],"summary":"Contacts Merges","operationId":"contactsMerges","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/notes":{"get":{"tags":["contacts"],"summary":"Contacts Notes Index","operationId":"contactsNotesIndex","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["contacts"],"summary":"Contacts Notes Store","operationId":"contactsNotesStore","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/notes\/{note}":{"patch":{"tags":["contacts"],"summary":"Contacts Notes Update","operationId":"contactsNotesUpdate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"note","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["contacts"],"summary":"Contacts Notes Destroy","operationId":"contactsNotesDestroy","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"note","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/notes\/{note}\/complete":{"post":{"tags":["contacts"],"summary":"Contacts Tasks Complete","operationId":"contactsTasksComplete","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"note","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/notes\/{note}\/reopen":{"post":{"tags":["contacts"],"summary":"Contacts Tasks Reopen","operationId":"contactsTasksReopen","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"note","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/score":{"get":{"tags":["contacts"],"summary":"Contacts Score","operationId":"contactsScore","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/score-history":{"get":{"tags":["contacts"],"summary":"Contacts Score History","operationId":"contactsScoreHistory","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/subject-requests":{"delete":{"tags":["contacts"],"summary":"Dsar Delete","operationId":"dsarDelete","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/subject-requests\/export":{"post":{"tags":["contacts"],"summary":"Dsar Export","operationId":"dsarExport","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/timeline":{"get":{"tags":["contacts"],"summary":"Contacts Timeline","operationId":"contactsTimeline","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/contacts\/{contact}\/timeline\/summary":{"get":{"tags":["contacts"],"summary":"Contacts Timeline Summary","operationId":"contactsTimelineSummary","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Conversation"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Conversation"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/unread-summary":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations\/unread-summary","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations\/{conversation}","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Conversation"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/assign":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/assign","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/collaborators":{"get":{"tags":["conversations"],"summary":"Conversations Collaborators Index","operationId":"conversationsCollaboratorsIndex","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["conversations"],"summary":"Conversations Collaborators Store","operationId":"conversationsCollaboratorsStore","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/collaborators\/{userId}":{"delete":{"tags":["conversations"],"summary":"Conversations Collaborators Destroy","operationId":"conversationsCollaboratorsDestroy","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"userId","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/escalations":{"get":{"tags":["conversations"],"summary":"Conversations Escalations","operationId":"conversationsEscalations","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/favorite":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/favorite","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/messages":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations\/{conversation}\/messages","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/messages","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/messages\/{message}\/react":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/messages\/{message}\/react","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"message","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/notes":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations\/{conversation}\/notes","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/notes","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/pin":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/pin","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/read":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/read","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/snooze":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/snooze","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/status":{"patch":{"tags":["conversations"],"summary":"PATCH api\/v1\/conversations\/{conversation}\/status","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/subscribe":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/subscribe","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/transfer":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/transfer","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/typing":{"post":{"tags":["conversations"],"summary":"POST api\/v1\/conversations\/{conversation}\/typing","security":[{"bearerAuth":["conversations.write"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/conversations\/{conversation}\/window":{"get":{"tags":["conversations"],"summary":"GET api\/v1\/conversations\/{conversation}\/window","security":[{"bearerAuth":["conversations.read"]}],"parameters":[{"name":"conversation","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/custom-fields":{"get":{"tags":["custom-fields"],"summary":"Custom Fields Index","operationId":"customFieldsIndex","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["custom-fields"],"summary":"Custom Fields Store","operationId":"customFieldsStore","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/custom-fields\/{customField}":{"get":{"tags":["custom-fields"],"summary":"Custom Fields Show","operationId":"customFieldsShow","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["custom-fields"],"summary":"Custom Fields Update","operationId":"customFieldsUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["custom-fields"],"summary":"Custom Fields Update","operationId":"customFieldsUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["custom-fields"],"summary":"Custom Fields Destroy","operationId":"customFieldsDestroy","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"customField","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/dashboards":{"get":{"tags":["dashboards"],"summary":"Dashboards Index","operationId":"dashboardsIndex","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["dashboards"],"summary":"Dashboards Store","operationId":"dashboardsStore","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/dashboards\/{dashboard}":{"get":{"tags":["dashboards"],"summary":"Dashboards Show","operationId":"dashboardsShow","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["dashboards"],"summary":"Dashboards Update","operationId":"dashboardsUpdate","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["dashboards"],"summary":"Dashboards Destroy","operationId":"dashboardsDestroy","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/dashboards\/{dashboard}\/widgets":{"post":{"tags":["dashboards"],"summary":"Dashboards Widgets Store","operationId":"dashboardsWidgetsStore","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/dashboards\/{dashboard}\/widgets\/{widget}":{"patch":{"tags":["dashboards"],"summary":"Dashboards Widgets Update","operationId":"dashboardsWidgetsUpdate","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["dashboards"],"summary":"Dashboards Widgets Destroy","operationId":"dashboardsWidgetsDestroy","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"dashboard","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"widget","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals":{"get":{"tags":["deals"],"summary":"Deals Index","operationId":"dealsIndex","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Deal"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["deals"],"summary":"Deals Store","operationId":"dealsStore","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Deal"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}":{"get":{"tags":["deals"],"summary":"Deals Show","operationId":"dealsShow","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Deal"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["deals"],"summary":"Deals Update","operationId":"dealsUpdate","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Deal"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["deals"],"summary":"Deals Update","operationId":"dealsUpdate","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Deal"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["deals"],"summary":"Deals Destroy","operationId":"dealsDestroy","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/conversation":{"post":{"tags":["deals"],"summary":"Deals Conversation","operationId":"dealsConversation","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/forecast":{"get":{"tags":["deals"],"summary":"Deals Forecast","operationId":"dealsForecast","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/history":{"get":{"tags":["deals"],"summary":"Deals History","operationId":"dealsHistory","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/lose":{"post":{"tags":["deals"],"summary":"Deals Lose","operationId":"dealsLose","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/stage":{"patch":{"tags":["deals"],"summary":"Deals Stage","operationId":"dealsStage","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/deals\/{deal}\/win":{"post":{"tags":["deals"],"summary":"Deals Win","operationId":"dealsWin","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"deal","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/filters\/preview":{"post":{"tags":["filters"],"summary":"Filters Preview","operationId":"filtersPreview","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/filters\/{subject}\/schema":{"get":{"tags":["filters"],"summary":"Filters Schema","operationId":"filtersSchema","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"subject","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/filters\/{subject}\/validate":{"post":{"tags":["filters"],"summary":"Filters Validate","operationId":"filtersValidate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"subject","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/forms\/{form}":{"get":{"tags":["forms"],"summary":"Public Forms Show","operationId":"publicFormsShow","security":[{"bearerAuth":["forms.read"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/forms\/{form}\/submit":{"post":{"tags":["forms"],"summary":"Public Forms Submit","operationId":"publicFormsSubmit","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/forms\/{form}\/uploads":{"post":{"tags":["forms"],"summary":"Public Forms Upload","operationId":"publicFormsUpload","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/funnels":{"get":{"tags":["funnels"],"summary":"Funnels Index","operationId":"funnelsIndex","security":[{"bearerAuth":["funnels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["funnels"],"summary":"Funnels Store","operationId":"funnelsStore","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/funnels\/{funnel}":{"get":{"tags":["funnels"],"summary":"Funnels Show","operationId":"funnelsShow","security":[{"bearerAuth":["funnels.read"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["funnels"],"summary":"Funnels Update","operationId":"funnelsUpdate","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["funnels"],"summary":"Funnels Destroy","operationId":"funnelsDestroy","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/funnels\/{funnel}\/report":{"get":{"tags":["funnels"],"summary":"Funnels Report","operationId":"funnelsReport","security":[{"bearerAuth":["funnels.read"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/funnels\/{funnel}\/steps":{"post":{"tags":["funnels"],"summary":"Funnels Steps Store","operationId":"funnelsStepsStore","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/funnels\/{funnel}\/steps\/{step}":{"patch":{"tags":["funnels"],"summary":"Funnels Steps Update","operationId":"funnelsStepsUpdate","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"step","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["funnels"],"summary":"Funnels Steps Destroy","operationId":"funnelsStepsDestroy","security":[{"bearerAuth":["funnels.write"]}],"parameters":[{"name":"funnel","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"step","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/invoices":{"get":{"tags":["invoices"],"summary":"Invoices Index","operationId":"invoicesIndex","security":[{"bearerAuth":["invoices.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["invoices"],"summary":"Invoices Store","operationId":"invoicesStore","security":[{"bearerAuth":["invoices.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/invoices\/{invoice}":{"get":{"tags":["invoices"],"summary":"Invoices Show","operationId":"invoicesShow","security":[{"bearerAuth":["invoices.read"]}],"parameters":[{"name":"invoice","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/invoices\/{invoice}\/pdf":{"get":{"tags":["invoices"],"summary":"Invoices Pdf","operationId":"invoicesPdf","security":[{"bearerAuth":["invoices.read"]}],"parameters":[{"name":"invoice","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/leads":{"get":{"tags":["leads"],"summary":"Leads Index","operationId":"leadsIndex","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["leads"],"summary":"Leads Store","operationId":"leadsStore","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/leads\/{lead}":{"get":{"tags":["leads"],"summary":"Leads Show","operationId":"leadsShow","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["leads"],"summary":"Leads Update","operationId":"leadsUpdate","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["leads"],"summary":"Leads Update","operationId":"leadsUpdate","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["leads"],"summary":"Leads Destroy","operationId":"leadsDestroy","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/leads\/{lead}\/convert":{"post":{"tags":["leads"],"summary":"Leads Convert","operationId":"leadsConvert","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/leads\/{lead}\/status":{"patch":{"tags":["leads"],"summary":"Leads Status","operationId":"leadsStatus","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"lead","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/me":{"get":{"tags":["me"],"summary":"Account Me","operationId":"accountMe","security":[{"bearerAuth":["users.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/opportunities\/win-rate":{"get":{"tags":["opportunities"],"summary":"Opportunities Win Rate","operationId":"opportunitiesWinRate","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments":{"get":{"tags":["payments"],"summary":"Payments Index","operationId":"paymentsIndex","security":[{"bearerAuth":["payments.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["payments"],"summary":"Payments Store","operationId":"paymentsStore","security":[{"bearerAuth":["payments.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments\/paypal\/return":{"get":{"tags":["payments"],"summary":"Public Payments Paypal Return","operationId":"publicPaymentsPaypalReturn","security":[{"bearerAuth":["payments.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments\/webhook\/{gateway}":{"post":{"tags":["payments"],"summary":"Public Payments Webhook","operationId":"publicPaymentsWebhook","security":[{"bearerAuth":["payments.write"]}],"parameters":[{"name":"gateway","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments\/{payment}":{"get":{"tags":["payments"],"summary":"Payments Show","operationId":"paymentsShow","security":[{"bearerAuth":["payments.read"]}],"parameters":[{"name":"payment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments\/{payment}\/approve":{"post":{"tags":["payments"],"summary":"Payments Approve","operationId":"paymentsApprove","security":[{"bearerAuth":["payments.write"]}],"parameters":[{"name":"payment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/payments\/{payment}\/reject":{"post":{"tags":["payments"],"summary":"Payments Reject","operationId":"paymentsReject","security":[{"bearerAuth":["payments.write"]}],"parameters":[{"name":"payment","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines":{"get":{"tags":["pipelines"],"summary":"Pipelines Index","operationId":"pipelinesIndex","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["pipelines"],"summary":"Pipelines Store","operationId":"pipelinesStore","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}":{"patch":{"tags":["pipelines"],"summary":"Pipelines Update","operationId":"pipelinesUpdate","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/board":{"get":{"tags":["pipelines"],"summary":"Pipelines Board","operationId":"pipelinesBoard","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/cohort":{"get":{"tags":["pipelines"],"summary":"Pipelines Cohort","operationId":"pipelinesCohort","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/forecast":{"get":{"tags":["pipelines"],"summary":"Pipelines Forecast","operationId":"pipelinesForecast","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/funnel":{"get":{"tags":["pipelines"],"summary":"Pipelines Funnel","operationId":"pipelinesFunnel","security":[{"bearerAuth":["opportunities.read"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/stages":{"post":{"tags":["pipelines"],"summary":"Pipelines Stages Store","operationId":"pipelinesStagesStore","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/pipelines\/{pipeline}\/stages\/order":{"put":{"tags":["pipelines"],"summary":"Pipelines Stages Order","operationId":"pipelinesStagesOrder","security":[{"bearerAuth":["opportunities.write"]}],"parameters":[{"name":"pipeline","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/profile":{"patch":{"tags":["profile"],"summary":"Account Profile Update","operationId":"accountProfileUpdate","security":[{"bearerAuth":["users.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/record-types":{"get":{"tags":["record-types"],"summary":"Record Types Index","operationId":"recordTypesIndex","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["record-types"],"summary":"Record Types Store","operationId":"recordTypesStore","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/record-types\/{recordType}":{"get":{"tags":["record-types"],"summary":"Record Types Show","operationId":"recordTypesShow","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"recordType","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["record-types"],"summary":"Record Types Update","operationId":"recordTypesUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"recordType","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["record-types"],"summary":"Record Types Update","operationId":"recordTypesUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"recordType","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["record-types"],"summary":"Record Types Destroy","operationId":"recordTypesDestroy","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"recordType","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/records":{"get":{"tags":["records"],"summary":"Records Index","operationId":"recordsIndex","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["records"],"summary":"Records Store","operationId":"recordsStore","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/records\/contact\/{contact}":{"get":{"tags":["records"],"summary":"Records Contact","operationId":"recordsContact","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"contact","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/records\/{record}":{"get":{"tags":["records"],"summary":"Records Show","operationId":"recordsShow","security":[{"bearerAuth":["custom_objects.read"]}],"parameters":[{"name":"record","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["records"],"summary":"Records Update","operationId":"recordsUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"record","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["records"],"summary":"Records Update","operationId":"recordsUpdate","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"record","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["records"],"summary":"Records Destroy","operationId":"recordsDestroy","security":[{"bearerAuth":["custom_objects.write"]}],"parameters":[{"name":"record","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/report-schedules":{"get":{"tags":["report-schedules"],"summary":"Report Schedules Index","operationId":"reportSchedulesIndex","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["report-schedules"],"summary":"Report Schedules Store","operationId":"reportSchedulesStore","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/report-schedules\/{schedule}":{"get":{"tags":["report-schedules"],"summary":"Report Schedules Show","operationId":"reportSchedulesShow","security":[{"bearerAuth":["analytics.read"]}],"parameters":[{"name":"schedule","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["report-schedules"],"summary":"Report Schedules Update","operationId":"reportSchedulesUpdate","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"schedule","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["report-schedules"],"summary":"Report Schedules Update","operationId":"reportSchedulesUpdate","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"schedule","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["report-schedules"],"summary":"Report Schedules Destroy","operationId":"reportSchedulesDestroy","security":[{"bearerAuth":["analytics.write"]}],"parameters":[{"name":"schedule","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/scheduling\/push\/google":{"post":{"tags":["scheduling"],"summary":"Scheduling Push Google","operationId":"schedulingPushGoogle","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/scheduling\/push\/microsoft":{"get":{"tags":["scheduling"],"summary":"Scheduling Push Microsoft","operationId":"schedulingPushMicrosoft","security":[{"bearerAuth":["appointments.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["scheduling"],"summary":"Scheduling Push Microsoft","operationId":"schedulingPushMicrosoft","security":[{"bearerAuth":["appointments.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites":{"get":{"tags":["sites"],"summary":"Sites Index","operationId":"sitesIndex","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["sites"],"summary":"Sites Store","operationId":"sitesStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}":{"get":{"tags":["sites"],"summary":"Sites Show","operationId":"sitesShow","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["sites"],"summary":"Sites Update","operationId":"sitesUpdate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["sites"],"summary":"Sites Destroy","operationId":"sitesDestroy","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/domains":{"post":{"tags":["sites"],"summary":"Sites Domains Store","operationId":"sitesDomainsStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/domains\/{domain}":{"delete":{"tags":["sites"],"summary":"Sites Domains Destroy","operationId":"sitesDomainsDestroy","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/domains\/{domain}\/verify":{"post":{"tags":["sites"],"summary":"Sites Domains Verify","operationId":"sitesDomainsVerify","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/hosting\/domains":{"get":{"tags":["sites"],"summary":"Sites Hosting Domains","operationId":"sitesHostingDomains","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["sites"],"summary":"Sites Hosting Attach","operationId":"sitesHostingAttach","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/hosting\/domains\/{domain}\/certificate":{"post":{"tags":["sites"],"summary":"Sites Hosting Certificate","operationId":"sitesHostingCertificate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/hosting\/domains\/{domain}\/issue":{"post":{"tags":["sites"],"summary":"Sites Hosting Issue","operationId":"sitesHostingIssue","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/hosting\/domains\/{domain}\/verify":{"post":{"tags":["sites"],"summary":"Sites Hosting Verify","operationId":"sitesHostingVerify","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"domain","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/hosting\/purge":{"post":{"tags":["sites"],"summary":"Sites Hosting Purge","operationId":"sitesHostingPurge","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages":{"post":{"tags":["sites"],"summary":"Sites Pages Store","operationId":"sitesPagesStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages\/{page}":{"patch":{"tags":["sites"],"summary":"Sites Pages Update","operationId":"sitesPagesUpdate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["sites"],"summary":"Sites Pages Destroy","operationId":"sitesPagesDestroy","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages\/{page}\/access":{"put":{"tags":["sites"],"summary":"Sites Pages Access","operationId":"sitesPagesAccess","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages\/{page}\/publish":{"post":{"tags":["sites"],"summary":"Sites Pages Publish","operationId":"sitesPagesPublish","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages\/{page}\/unpublish":{"post":{"tags":["sites"],"summary":"Sites Pages Unpublish","operationId":"sitesPagesUnpublish","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/pages\/{page}\/validate":{"post":{"tags":["sites"],"summary":"Sites Pages Validate","operationId":"sitesPagesValidate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"page","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/posts":{"get":{"tags":["sites"],"summary":"Sites Posts Index","operationId":"sitesPostsIndex","security":[{"bearerAuth":["sites.read"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["sites"],"summary":"Sites Posts Store","operationId":"sitesPostsStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/posts\/{post}":{"patch":{"tags":["sites"],"summary":"Sites Posts Update","operationId":"sitesPostsUpdate","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"post","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/posts\/{post}\/publish":{"post":{"tags":["sites"],"summary":"Sites Posts Publish","operationId":"sitesPostsPublish","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"post","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/posts\/{post}\/unpublish":{"post":{"tags":["sites"],"summary":"Sites Posts Unpublish","operationId":"sitesPostsUnpublish","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"post","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/sites\/{site}\/redirects":{"post":{"tags":["sites"],"summary":"Sites Redirects Store","operationId":"sitesRedirectsStore","security":[{"bearerAuth":["sites.write"]}],"parameters":[{"name":"site","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/tags":{"get":{"tags":["tags"],"summary":"Tags Index","operationId":"tagsIndex","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["tags"],"summary":"Tags Store","operationId":"tagsStore","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/tags\/{tag}":{"get":{"tags":["tags"],"summary":"Tags Show","operationId":"tagsShow","security":[{"bearerAuth":["contacts.read"]}],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["tags"],"summary":"Tags Update","operationId":"tagsUpdate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["tags"],"summary":"Tags Update","operationId":"tagsUpdate","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["tags"],"summary":"Tags Destroy","operationId":"tagsDestroy","security":[{"bearerAuth":["contacts.write"]}],"parameters":[{"name":"tag","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates":{"get":{"tags":["templates"],"summary":"Templates Index","operationId":"templatesIndex","security":[{"bearerAuth":["templates.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Template"}},"meta":{"$ref":"#\/components\/schemas\/CursorMeta"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["templates"],"summary":"Templates Store","operationId":"templatesStore","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Template"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/sync":{"post":{"tags":["templates"],"summary":"Templates Sync","operationId":"templatesSync","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/{template}":{"get":{"tags":["templates"],"summary":"Templates Show","operationId":"templatesShow","security":[{"bearerAuth":["templates.read"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Template"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"put":{"tags":["templates"],"summary":"Templates Update","operationId":"templatesUpdate","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Template"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["templates"],"summary":"Templates Update","operationId":"templatesUpdate","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Template"}}}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["templates"],"summary":"Templates Destroy","operationId":"templatesDestroy","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/{template}\/approve":{"post":{"tags":["templates"],"summary":"Templates Approve","operationId":"templatesApprove","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/{template}\/preview":{"post":{"tags":["templates"],"summary":"Templates Preview","operationId":"templatesPreview","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/{template}\/reject":{"post":{"tags":["templates"],"summary":"Templates Reject","operationId":"templatesReject","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/templates\/{template}\/submit":{"post":{"tags":["templates"],"summary":"Templates Submit","operationId":"templatesSubmit","security":[{"bearerAuth":["templates.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/web-forms":{"get":{"tags":["web-forms"],"summary":"Web Forms Index","operationId":"webFormsIndex","security":[{"bearerAuth":["forms.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["web-forms"],"summary":"Web Forms Store","operationId":"webFormsStore","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/web-forms\/import":{"post":{"tags":["web-forms"],"summary":"Web Forms Import","operationId":"webFormsImport","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/web-forms\/{form}":{"get":{"tags":["web-forms"],"summary":"Web Forms Show","operationId":"webFormsShow","security":[{"bearerAuth":["forms.read"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"patch":{"tags":["web-forms"],"summary":"Web Forms Update","operationId":"webFormsUpdate","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"delete":{"tags":["web-forms"],"summary":"Web Forms Destroy","operationId":"webFormsDestroy","security":[{"bearerAuth":["forms.write"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/web-forms\/{form}\/export":{"get":{"tags":["web-forms"],"summary":"Web Forms Export","operationId":"webFormsExport","security":[{"bearerAuth":["forms.read"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/web-forms\/{form}\/submissions":{"get":{"tags":["web-forms"],"summary":"Web Forms Submissions","operationId":"webFormsSubmissions","security":[{"bearerAuth":["forms.read"]}],"parameters":[{"name":"form","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/webhooks":{"get":{"tags":["webhooks"],"summary":"Webhooks Index","operationId":"webhooksIndex","security":[{"bearerAuth":["webhooks.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["webhooks"],"summary":"Webhooks Store","operationId":"webhooksStore","security":[{"bearerAuth":["webhooks.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/calls":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Calls","operationId":"whatsappCalls","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/calls\/{account}\/settings":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Calls Settings","operationId":"whatsappCallsSettings","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"account","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/carts":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Carts","operationId":"whatsappCarts","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/carts\/{cart}\/convert":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Carts Convert","operationId":"whatsappCartsConvert","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"cart","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/catalogs":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Catalogs","operationId":"whatsappCatalogs","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["whatsapp"],"summary":"Whatsapp Catalogs Store","operationId":"whatsappCatalogsStore","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/catalogs\/{catalog}\/products":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Catalogs Products","operationId":"whatsappCatalogsProducts","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"catalog","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/catalogs\/{catalog}\/sync":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Catalogs Sync","operationId":"whatsappCatalogsSync","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"catalog","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/conversation-costs":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Conversation Costs","operationId":"whatsappConversationCosts","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/ctwa\/conversions":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Ctwa Conversions","operationId":"whatsappCtwaConversions","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/ctwa\/referrals":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Ctwa Referrals","operationId":"whatsappCtwaReferrals","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/ctwa\/report":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Ctwa Report","operationId":"whatsappCtwaReport","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Flows","operationId":"whatsappFlows","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["whatsapp"],"summary":"Whatsapp Flows Store","operationId":"whatsappFlowsStore","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows\/{flow}":{"patch":{"tags":["whatsapp"],"summary":"Whatsapp Flows Update","operationId":"whatsappFlowsUpdate","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows\/{flow}\/publish":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Flows Publish","operationId":"whatsappFlowsPublish","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows\/{flow}\/publish-to-meta":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Flows Publish Meta","operationId":"whatsappFlowsPublishMeta","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows\/{flow}\/refresh":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Flows Refresh","operationId":"whatsappFlowsRefresh","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/flows\/{flow}\/responses":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Flows Responses","operationId":"whatsappFlowsResponses","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"flow","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/history-imports":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Imports Index","operationId":"whatsappImportsIndex","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["whatsapp"],"summary":"Whatsapp Imports Store","operationId":"whatsappImportsStore","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/history-imports\/preview":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Imports Preview","operationId":"whatsappImportsPreview","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/history-imports\/upload":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Imports Upload","operationId":"whatsappImportsUpload","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/history-imports\/{import}\/revert":{"post":{"tags":["whatsapp"],"summary":"Whatsapp Imports Revert","operationId":"whatsappImportsRevert","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"import","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/number-health":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Number Health","operationId":"whatsappNumberHealth","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/policies":{"get":{"tags":["whatsapp"],"summary":"Whatsapp Policies","operationId":"whatsappPolicies","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["whatsapp"],"summary":"Whatsapp Policies Set","operationId":"whatsappPoliciesSet","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/whatsapp\/templates\/{template}\/rich":{"put":{"tags":["whatsapp"],"summary":"Whatsapp Templates Rich","operationId":"whatsappTemplatesRich","security":[{"bearerAuth":["channels.write"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"get":{"tags":["whatsapp"],"summary":"Whatsapp Templates Rich Preview","operationId":"whatsappTemplatesRichPreview","security":[{"bearerAuth":["channels.read"]}],"parameters":[{"name":"template","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/workspaces":{"get":{"tags":["workspaces"],"summary":"Account Workspaces Index","operationId":"accountWorkspacesIndex","security":[{"bearerAuth":["workspaces.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}},"post":{"tags":["workspaces"],"summary":"Account Workspaces Store","operationId":"accountWorkspacesStore","security":[{"bearerAuth":["workspaces.write"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/workspaces\/current":{"get":{"tags":["workspaces"],"summary":"Account Workspaces Current","operationId":"accountWorkspacesCurrent","security":[{"bearerAuth":["workspaces.read"]}],"parameters":[{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"responses":{"200":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/workspaces\/{workspace}\/star":{"post":{"tags":["workspaces"],"summary":"Account Workspaces Star","operationId":"accountWorkspacesStar","security":[{"bearerAuth":["workspaces.write"]}],"parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}},"\/workspaces\/{workspace}\/switch":{"post":{"tags":["workspaces"],"summary":"Account Workspaces Switch","operationId":"accountWorkspacesSwitch","security":[{"bearerAuth":["workspaces.write"]}],"parameters":[{"name":"workspace","in":"path","required":true,"schema":{"type":"string","format":null}},{"name":"X-Workspace-Id","in":"header","required":false,"description":"The workspace to act in. Required when the credential can reach more than one.","schema":{"type":"string","format":"uuid"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object"}}}},"responses":{"201":{"description":"Success","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Envelope"}}}},"401":{"$ref":"#\/components\/responses\/Unauthorised"},"403":{"$ref":"#\/components\/responses\/Forbidden"},"422":{"$ref":"#\/components\/responses\/Invalid"},"429":{"$ref":"#\/components\/responses\/RateLimited"}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An OAuth access token or personal access token."},"apiKey":{"type":"apiKey","in":"header","name":"X-Api-Key"}},"schemas":{"Contact":{"type":"object","description":"Requires the contacts.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"country":{"type":["string","null"]},"source":{"type":["string","null"]},"score":{"type":["integer","null"]},"is_blocked":{"type":["boolean","null"]},"opted_in_at":{"type":["string","null"],"format":"date-time"},"last_contacted_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Conversation":{"type":"object","description":"Requires the conversations.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"channel":{"type":["string","null"]},"status":{"type":["string","null"]},"priority":{"type":["string","null"]},"assigned_to":{"type":["string","null"]},"contact_id":{"type":["string","null"],"format":"uuid"},"unread_count":{"type":["integer","null"]},"last_message_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Message":{"type":"object","description":"Requires the messages.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"conversation_id":{"type":["string","null"],"format":"uuid"},"direction":{"type":["string","null"]},"type":{"type":["string","null"]},"status":{"type":["string","null"]},"body":{"type":["string","null"]},"sent_at":{"type":["string","null"],"format":"date-time"},"delivered_at":{"type":["string","null"],"format":"date-time"},"read_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Deal":{"type":"object","description":"Requires the opportunities.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"title":{"type":["string","null"]},"stage":{"type":["string","null"]},"status":{"type":["string","null"]},"amount_minor":{"type":["integer","null"]},"currency":{"type":["string","null"]},"owner_id":{"type":["string","null"],"format":"uuid"},"contact_id":{"type":["string","null"],"format":"uuid"},"company_id":{"type":["string","null"],"format":"uuid"},"expected_close_date":{"type":["string","null"],"format":"date"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Appointment":{"type":"object","description":"Requires the appointments.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"calendar_id":{"type":["string","null"],"format":"uuid"},"contact_id":{"type":["string","null"],"format":"uuid"},"status":{"type":["string","null"]},"starts_at":{"type":["string","null"],"format":"date-time"},"ends_at":{"type":["string","null"],"format":"date-time"},"timezone":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Template":{"type":"object","description":"Requires the templates.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"language":{"type":["string","null"]},"category":{"type":["string","null"]},"status":{"type":["string","null"]},"body":{"type":["string","null"]},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Campaign":{"type":"object","description":"Requires the campaigns.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"channel":{"type":["string","null"]},"type":{"type":["string","null"]},"status":{"type":["string","null"]},"priority":{"type":["string","null"]},"scheduled_at":{"type":["string","null"],"format":"date-time"},"started_at":{"type":["string","null"],"format":"date-time"},"completed_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Company":{"type":"object","description":"Requires the companies.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"name":{"type":["string","null"]},"domain":{"type":["string","null"]},"industry":{"type":["string","null"]},"size":{"type":["string","null"]},"phone":{"type":["string","null"]},"email":{"type":["string","null"]},"owner_id":{"type":["string","null"],"format":"uuid"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Invoice":{"type":"object","description":"Requires the invoices.read scope.","properties":{"id":{"type":["string","null"],"format":"uuid"},"number":{"type":["string","null"]},"status":{"type":["string","null"]},"amount":{"type":["number","null"]},"currency":{"type":["string","null"]},"due_date":{"type":["string","null"],"format":"date"},"paid_at":{"type":["string","null"],"format":"date-time"},"created_at":{"type":["string","null"],"format":"date-time"},"updated_at":{"type":["string","null"],"format":"date-time"}},"additionalProperties":true},"Envelope":{"type":"object","properties":{"data":{"description":"The resource, or a list of them."},"meta":{"type":"object","description":"Pagination and totals, when the endpoint returns a list."}}},"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"details":{"type":"object"}}}}},"CursorMeta":{"type":"object","properties":{"next_cursor":{"type":["string","null"],"description":"Pass as `cursor` to fetch the next page. Null on the last page."},"per_page":{"type":"integer"}}}},"responses":{"Unauthorised":{"description":"The credential is missing, expired or revoked.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"Forbidden":{"description":"The credential is valid but lacks the required scope.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"Invalid":{"description":"The request body failed validation.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}},"RateLimited":{"description":"Too many requests. Retry after the number of seconds in the Retry-After header.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Error"}}}}}}}