{ "openapi": "3.1.0", "info": { "title": "Quo Public API", "version": "1.0.0", "description": "API for connecting with Quo.", "contact": { "name": "Quo Support", "email": "support@quo.com", "url": "https://support.quo.com/" }, "termsOfService": "https://www.quo.com/terms" }, "paths": { "/a2p-registration": { "get": { "tags": [ "A2P Registration" ], "summary": "Get the A2P registration", "description": "Get the organization's A2P (10DLC) registration. Organizations have at most one registration. Returns a 404 rather than a null `data` field when no registration exists yet.", "operationId": "getA2PRegistration", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "draft", "status", "statusMessages", "autofillStatus", "type", "assignedPnId", "firstSubmittedAt", "createdAt", "updatedAt", "businessInfo", "messaging" ], "properties": { "id": { "description": "The unique identifier of the A2P registration.", "examples": [ "RG123abc" ], "example": "RG123abc", "type": "string", "pattern": "^RG(.*)$" }, "draft": { "type": "boolean", "description": "True if the registration has not yet been submitted for carrier approval. Combine with `status` to tell submission states apart: `draft: true, status: \"pending\"` means not yet submitted; `draft: false, status: \"pending\"` means submitted and awaiting carrier approval." }, "status": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "approved" }, { "type": "string", "const": "rejected" }, { "type": "string", "const": "failed" } ], "description": "The registration's overall status. `pending` is set both at creation and while awaiting carrier approval after submission — check `draft` to tell those two apart. `rejected` and `failed` both mean the registration must be resubmitted, which re-triggers billing.", "examples": [ "pending" ], "example": "pending" }, "statusMessages": { "type": "array", "items": { "type": "object", "required": [ "errorCode", "errorReason" ], "properties": { "errorCode": { "type": "number", "description": "The carrier error code associated with this status message." }, "errorReason": { "type": "string", "description": "A human-readable explanation of the status." }, "fieldName": { "type": "string", "description": "The single business-profile field this message refers to, if any." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "The business-profile fields this message refers to, if any." } } }, "description": "Carrier-reported reasons for the current status, most relevant when `status` is `rejected` or `failed`." }, "autofillStatus": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "in-progress" }, { "type": "string", "const": "completed" }, { "type": "string", "const": "failed" } ], "description": "Status of the automatic field-fill for this registration. `completed` means the messaging fields are generated and the registration can be submitted; `pending` or `in-progress` means submission is not yet allowed; `failed` means autofill did not complete and the registration must be updated and retried.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "standard" }, { "type": "string", "const": "lv-standard" }, { "type": "string", "const": "starter" }, { "type": "string", "const": "sole-prop" } ], "description": "The type of A2P registration.", "examples": [ "standard" ], "example": "standard" }, { "type": "null" } ] }, "assignedPnId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "firstSubmittedAt": { "anyOf": [ { "description": "The timestamp the registration was first submitted for carrier approval.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp the registration was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp the registration was last updated.", "type": "string", "format": "date-time" }, "businessInfo": { "type": "object", "required": [ "name", "alternateName", "businessType", "companyType", "industry", "employeeCount", "avgDailyCallVolume", "regionsOfOperation", "websiteUrl", "idType", "idNumber", "ticker", "exchange", "address", "personOfContact" ], "properties": { "name": { "anyOf": [ { "type": "string", "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, { "type": "null" } ] }, "alternateName": { "anyOf": [ { "type": "string", "description": "An alternate or doing-business-as name for the business." }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "description": "The legal structure of the business.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company: one of `Private`, `Public`, `Non-profit`, `Government`.", "examples": [ "Private" ], "example": "Private" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "description": "The industry the business operates in." }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number", "description": "The number of employees at the business." }, { "type": "null" } ] }, "avgDailyCallVolume": { "anyOf": [ { "type": "number", "description": "The business's average daily call volume." }, { "type": "null" } ] }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`." }, "websiteUrl": { "anyOf": [ { "type": "string", "description": "The business's website URL.", "format": "uri" }, { "type": "null" } ] }, "idType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "Canada: Business Number (BIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Canada: Canadian Corporation Number (CCN)" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "USA: DUNS Number (Dun & Bradstreet)" }, { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `Australia: Company Number from ASIC (ACN)`, `Canada: Business Number (BIN)`, `Canada: Canadian Business Number (BN-9)`, `Canada: Canadian Corporation Number (CCN)`, `Estonia: VAT Number`, `Great Britain: Company Number`, `India: Corporate Identity Number`, `Israel: Registration Number`, `Romania: VAT Registration Number`, `USA: DUNS Number (Dun & Bradstreet)`, `USA: Employer Identification Number (EIN)`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, { "type": "null" } ] }, "idNumber": { "anyOf": [ { "type": "string", "description": "The business's government-issued tax ID number." }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string", "description": "The business's stock ticker symbol, if publicly traded." }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string", "description": "The stock exchange the business's ticker is listed on, if publicly traded." }, { "type": "null" } ] }, "address": { "type": "object", "required": [ "line1", "line2", "city", "region", "postalCode", "country" ], "properties": { "line1": { "anyOf": [ { "type": "string", "description": "The first line of the business's registered address." }, { "type": "null" } ] }, "line2": { "anyOf": [ { "type": "string", "description": "The second line of the business's registered address." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "The city of the business's registered address." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "The state or region of the business's registered address." }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string", "description": "The postal code of the business's registered address." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" }, { "type": "null" } ] } } }, "personOfContact": { "type": "object", "required": [ "firstName", "lastName", "jobTitle", "jobPosition", "email", "phoneNumber" ], "properties": { "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the business contact submitting this registration." }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the business contact submitting this registration." }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "description": "The job title of the business contact submitting this registration." }, { "type": "null" } ] }, "jobPosition": { "anyOf": [ { "type": "string", "description": "The job position of the business contact submitting this registration." }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "description": "The business contact's email address.", "format": "email" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string", "description": "The business contact's phone number." }, { "type": "null" } ] } } } } }, "messaging": { "type": "object", "required": [ "useCase", "personalUse", "consent" ], "properties": { "useCase": { "anyOf": [ { "type": "string", "description": "The messaging use case this registration was created for." }, { "type": "null" } ] }, "personalUse": { "anyOf": [ { "type": "boolean", "description": "Whether this registration is for an individual sending messages personally." }, { "type": "null" } ] }, "consent": { "anyOf": [ { "type": "object", "properties": { "digitalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "mobileApp": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "onSite": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "other": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "physicalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "textMessage": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "verbal": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "websiteForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "written": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The organization has no A2P registration", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } } } } } }, "post": { "tags": [ "A2P Registration" ], "summary": "Create the A2P registration", "description": "Create the organization's A2P (10DLC) draft registration. Organizations have at most one registration, so this returns 409 if one already exists.", "operationId": "createA2PRegistration", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "name", "businessType", "companyType", "industry", "employeeCount", "avgDailyCallVolume", "regionsOfOperation", "websiteUrl", "idType", "idNumber", "address", "personOfContact", "messageTypes" ], "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, "alternateName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "An alternate or doing-business-as name for the business.", "examples": [ "Acme" ], "example": "Acme" }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "const": "Sole Proprietorship" }, { "type": "string", "const": "Partnership" }, { "type": "string", "const": "Corporation" }, { "type": "string", "const": "Co-operative" }, { "type": "string", "const": "Limited Liability Corporation" }, { "type": "string", "const": "Non-profit Corporation" } ], "description": "The legal structure of the business: one of `Sole Proprietorship`, `Partnership`, `Corporation`, `Co-operative`, `Limited Liability Corporation`, `Non-profit Corporation`.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, "companyType": { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company. `ticker` and `exchange` are required when this is `Public`.", "examples": [ "Private" ], "example": "Private" }, "industry": { "anyOf": [ { "type": "string", "const": "Agriculture" }, { "type": "string", "const": "Automotive" }, { "type": "string", "const": "Banking" }, { "type": "string", "const": "Consumer" }, { "type": "string", "const": "Education" }, { "type": "string", "const": "Electronics" }, { "type": "string", "const": "Energy" }, { "type": "string", "const": "Engineering" }, { "type": "string", "const": "Fast moving consumer goods" }, { "type": "string", "const": "Financial" }, { "type": "string", "const": "Fintech" }, { "type": "string", "const": "Food and beverage" }, { "type": "string", "const": "Government" }, { "type": "string", "const": "Healthcare" }, { "type": "string", "const": "Hospitality" }, { "type": "string", "const": "Insurance" }, { "type": "string", "const": "Jewelry" }, { "type": "string", "const": "Legal" }, { "type": "string", "const": "Manufacturing" }, { "type": "string", "const": "Media" }, { "type": "string", "const": "Not for profit" }, { "type": "string", "const": "Oil and gas" }, { "type": "string", "const": "Online" }, { "type": "string", "const": "Raw materials" }, { "type": "string", "const": "Real estate" }, { "type": "string", "const": "Religion" }, { "type": "string", "const": "Retail" }, { "type": "string", "const": "Technology" }, { "type": "string", "const": "Telecommunications" }, { "type": "string", "const": "Transportation" }, { "type": "string", "const": "Travel" } ], "description": "The industry the business operates in: one of `Agriculture`, `Automotive`, `Banking`, `Consumer`, `Education`, `Electronics`, `Energy`, `Engineering`, `Fast moving consumer goods`, `Financial`, `Fintech`, `Food and beverage`, `Government`, `Healthcare`, `Hospitality`, `Insurance`, `Jewelry`, `Legal`, `Manufacturing`, `Media`, `Not for profit`, `Oil and gas`, `Online`, `Raw materials`, `Real estate`, `Religion`, `Retail`, `Technology`, `Telecommunications`, `Transportation`, `Travel`.", "examples": [ "Technology" ], "example": "Technology" }, "employeeCount": { "type": "integer", "minimum": 1, "description": "The number of employees at the business.", "examples": [ 25 ], "example": 25 }, "avgDailyCallVolume": { "type": "integer", "minimum": 1, "description": "The business's average daily call volume.", "examples": [ 100 ], "example": 100 }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "minItems": 1, "maxItems": 5, "uniqueItems": true, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`.", "examples": [ [ "USA and Canada" ] ], "example": [ "USA and Canada" ] }, "websiteUrl": { "type": "string", "minLength": 1, "maxLength": 255, "format": "uri", "description": "The business's website URL.", "examples": [ "https://acme.example" ], "example": "https://acme.example" }, "idType": { "anyOf": [ { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `USA: Employer Identification Number (EIN)`, `Canada: Canadian Business Number (BN-9)`, `Great Britain: Company Number`, `Australia: Company Number from ASIC (ACN)`, `India: Corporate Identity Number`, `Estonia: VAT Number`, `Romania: VAT Registration Number`, `Israel: Registration Number`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, "idNumber": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The business's government-issued tax ID number. An EIN must carry exactly nine digits, and separators such as the dash in `12-3456789` are ignored. A Canadian BN-9 must be exactly nine digits with no separators.", "examples": [ "12-3456789" ], "example": "12-3456789" }, "ticker": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "The business's stock ticker symbol. Required when `companyType` is `Public`.", "examples": [ "ACME" ], "example": "ACME" }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "NASDAQ" }, { "type": "string", "const": "NYSE" }, { "type": "string", "const": "AMEX" }, { "type": "string", "const": "AMX" }, { "type": "string", "const": "ASX" }, { "type": "string", "const": "B3" }, { "type": "string", "const": "BME" }, { "type": "string", "const": "BSE" }, { "type": "string", "const": "FRA" }, { "type": "string", "const": "ICEX" }, { "type": "string", "const": "JPX" }, { "type": "string", "const": "JSE" }, { "type": "string", "const": "KRX" }, { "type": "string", "const": "LON" }, { "type": "string", "const": "NSE" }, { "type": "string", "const": "OMX" }, { "type": "string", "const": "SEHK" }, { "type": "string", "const": "SGX" }, { "type": "string", "const": "SSE" }, { "type": "string", "const": "STO" }, { "type": "string", "const": "SWX" }, { "type": "string", "const": "SZSE" }, { "type": "string", "const": "TSX" }, { "type": "string", "const": "TWSE" }, { "type": "string", "const": "VSE" }, { "type": "string", "const": "Other" } ], "description": "The stock exchange the business's ticker is listed on. Required when `companyType` is `Public`. One of `NASDAQ`, `NYSE`, `AMEX`, `AMX`, `ASX`, `B3`, `BME`, `BSE`, `FRA`, `ICEX`, `JPX`, `JSE`, `KRX`, `LON`, `NSE`, `OMX`, `SEHK`, `SGX`, `SSE`, `STO`, `SWX`, `SZSE`, `TSX`, `TWSE`, `VSE`, `Other`.", "examples": [ "NASDAQ" ], "example": "NASDAQ" }, { "type": "null" } ] }, "address": { "type": "object", "required": [ "line1", "city", "region", "postalCode", "country" ], "properties": { "line1": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The first line of the business's registered address.", "examples": [ "1 Main St" ], "example": "1 Main St" }, "line2": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "The second line of the business's registered address.", "examples": [ "Suite 200" ], "example": "Suite 200" }, { "type": "null" } ] }, "city": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The city of the business's registered address.", "examples": [ "San Francisco" ], "example": "San Francisco" }, "region": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The state or region of the business's registered address.", "examples": [ "CA" ], "example": "CA" }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The postal code of the business's registered address.", "examples": [ "94110" ], "example": "94110" }, "country": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" } } }, "personOfContact": { "type": "object", "required": [ "firstName", "lastName", "jobTitle", "jobPosition", "email", "phoneNumber" ], "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The first name of the business contact submitting this registration.", "examples": [ "Ada" ], "example": "Ada" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The last name of the business contact submitting this registration.", "examples": [ "Lovelace" ], "example": "Lovelace" }, "jobTitle": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The job title of the business contact submitting this registration.", "examples": [ "CTO" ], "example": "CTO" }, "jobPosition": { "anyOf": [ { "type": "string", "const": "Other" }, { "type": "string", "const": "Director" }, { "type": "string", "const": "GM" }, { "type": "string", "const": "VP" }, { "type": "string", "const": "CEO" }, { "type": "string", "const": "CFO" }, { "type": "string", "const": "General Counsel" } ], "description": "The job position of the business contact submitting this registration: one of `Other`, `Director`, `GM`, `VP`, `CEO`, `CFO`, `General Counsel`.", "examples": [ "Director" ], "example": "Director" }, "email": { "type": "string", "minLength": 1, "maxLength": 255, "format": "email", "description": "The business contact's email address.", "examples": [ "ada@acme.example" ], "example": "ada@acme.example" }, "phoneNumber": { "type": "string", "maxLength": 255, "pattern": "^\\+[1-9]\\d{1,14}$", "description": "The business contact's phone number, in E.164 format.", "examples": [ "+15551234567" ], "example": "+15551234567" } } }, "messageTypes": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "appointments_scheduling" }, { "type": "string", "const": "transactional_notifications" }, { "type": "string", "const": "customer_support" }, { "type": "string", "const": "verification_security" }, { "type": "string", "const": "promotions_announcements" } ] }, "minItems": 1, "description": "The message-use types that autofill uses for this request. The registration does not store this value: send it again on any later request that starts autofill.", "examples": [ [ "customer_support", "transactional_notifications" ] ], "example": [ "customer_support", "transactional_notifications" ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "draft", "status", "statusMessages", "autofillStatus", "type", "assignedPnId", "firstSubmittedAt", "createdAt", "updatedAt", "businessInfo", "messaging" ], "properties": { "id": { "description": "The unique identifier of the A2P registration.", "examples": [ "RG123abc" ], "example": "RG123abc", "type": "string", "pattern": "^RG(.*)$" }, "draft": { "type": "boolean", "description": "True if the registration has not yet been submitted for carrier approval. Combine with `status` to tell submission states apart: `draft: true, status: \"pending\"` means not yet submitted; `draft: false, status: \"pending\"` means submitted and awaiting carrier approval." }, "status": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "approved" }, { "type": "string", "const": "rejected" }, { "type": "string", "const": "failed" } ], "description": "The registration's overall status. `pending` is set both at creation and while awaiting carrier approval after submission — check `draft` to tell those two apart. `rejected` and `failed` both mean the registration must be resubmitted, which re-triggers billing.", "examples": [ "pending" ], "example": "pending" }, "statusMessages": { "type": "array", "items": { "type": "object", "required": [ "errorCode", "errorReason" ], "properties": { "errorCode": { "type": "number", "description": "The carrier error code associated with this status message." }, "errorReason": { "type": "string", "description": "A human-readable explanation of the status." }, "fieldName": { "type": "string", "description": "The single business-profile field this message refers to, if any." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "The business-profile fields this message refers to, if any." } } }, "description": "Carrier-reported reasons for the current status, most relevant when `status` is `rejected` or `failed`." }, "autofillStatus": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "in-progress" }, { "type": "string", "const": "completed" }, { "type": "string", "const": "failed" } ], "description": "Status of the automatic field-fill for this registration. `completed` means the messaging fields are generated and the registration can be submitted; `pending` or `in-progress` means submission is not yet allowed; `failed` means autofill did not complete and the registration must be updated and retried.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "standard" }, { "type": "string", "const": "lv-standard" }, { "type": "string", "const": "starter" }, { "type": "string", "const": "sole-prop" } ], "description": "The type of A2P registration.", "examples": [ "standard" ], "example": "standard" }, { "type": "null" } ] }, "assignedPnId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "firstSubmittedAt": { "anyOf": [ { "description": "The timestamp the registration was first submitted for carrier approval.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp the registration was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp the registration was last updated.", "type": "string", "format": "date-time" }, "businessInfo": { "type": "object", "required": [ "name", "alternateName", "businessType", "companyType", "industry", "employeeCount", "avgDailyCallVolume", "regionsOfOperation", "websiteUrl", "idType", "idNumber", "ticker", "exchange", "address", "personOfContact" ], "properties": { "name": { "anyOf": [ { "type": "string", "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, { "type": "null" } ] }, "alternateName": { "anyOf": [ { "type": "string", "description": "An alternate or doing-business-as name for the business." }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "description": "The legal structure of the business.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company: one of `Private`, `Public`, `Non-profit`, `Government`.", "examples": [ "Private" ], "example": "Private" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "description": "The industry the business operates in." }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number", "description": "The number of employees at the business." }, { "type": "null" } ] }, "avgDailyCallVolume": { "anyOf": [ { "type": "number", "description": "The business's average daily call volume." }, { "type": "null" } ] }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`." }, "websiteUrl": { "anyOf": [ { "type": "string", "description": "The business's website URL.", "format": "uri" }, { "type": "null" } ] }, "idType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "Canada: Business Number (BIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Canada: Canadian Corporation Number (CCN)" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "USA: DUNS Number (Dun & Bradstreet)" }, { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `Australia: Company Number from ASIC (ACN)`, `Canada: Business Number (BIN)`, `Canada: Canadian Business Number (BN-9)`, `Canada: Canadian Corporation Number (CCN)`, `Estonia: VAT Number`, `Great Britain: Company Number`, `India: Corporate Identity Number`, `Israel: Registration Number`, `Romania: VAT Registration Number`, `USA: DUNS Number (Dun & Bradstreet)`, `USA: Employer Identification Number (EIN)`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, { "type": "null" } ] }, "idNumber": { "anyOf": [ { "type": "string", "description": "The business's government-issued tax ID number." }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string", "description": "The business's stock ticker symbol, if publicly traded." }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string", "description": "The stock exchange the business's ticker is listed on, if publicly traded." }, { "type": "null" } ] }, "address": { "type": "object", "required": [ "line1", "line2", "city", "region", "postalCode", "country" ], "properties": { "line1": { "anyOf": [ { "type": "string", "description": "The first line of the business's registered address." }, { "type": "null" } ] }, "line2": { "anyOf": [ { "type": "string", "description": "The second line of the business's registered address." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "The city of the business's registered address." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "The state or region of the business's registered address." }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string", "description": "The postal code of the business's registered address." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" }, { "type": "null" } ] } } }, "personOfContact": { "type": "object", "required": [ "firstName", "lastName", "jobTitle", "jobPosition", "email", "phoneNumber" ], "properties": { "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the business contact submitting this registration." }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the business contact submitting this registration." }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "description": "The job title of the business contact submitting this registration." }, { "type": "null" } ] }, "jobPosition": { "anyOf": [ { "type": "string", "description": "The job position of the business contact submitting this registration." }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "description": "The business contact's email address.", "format": "email" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string", "description": "The business contact's phone number." }, { "type": "null" } ] } } } } }, "messaging": { "type": "object", "required": [ "useCase", "personalUse", "consent" ], "properties": { "useCase": { "anyOf": [ { "type": "string", "description": "The messaging use case this registration was created for." }, { "type": "null" } ] }, "personalUse": { "anyOf": [ { "type": "boolean", "description": "Whether this registration is for an individual sending messages personally." }, { "type": "null" } ] }, "consent": { "anyOf": [ { "type": "object", "properties": { "digitalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "mobileApp": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "onSite": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "other": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "physicalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "textMessage": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "verbal": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "websiteForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "written": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Subscription Expired", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Subscription Expired" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "This subscription is not able to register for A2P", "docs": "https://quo.com/docs", "title": "Subscription Expired", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You must be an organization admin or owner to create an A2P registration", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Not Found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Conflict" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "This organization already has an A2P registration", "docs": "https://quo.com/docs", "title": "Conflict", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "idNumber must contain exactly nine digits for idType USA: Employer Identification Number (EIN)", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } } } } } }, "patch": { "tags": [ "A2P Registration" ], "summary": "Update the A2P registration", "description": "Update the organization's A2P (10DLC) draft registration. This is a true merge: a field left out of the request body is left unchanged. Returns 404 if the organization has no registration, and 409 if the registration is no longer a draft.", "operationId": "updateA2PRegistration", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, "alternateName": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "An alternate or doing-business-as name for the business.", "examples": [ "Acme" ], "example": "Acme" }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "const": "Sole Proprietorship" }, { "type": "string", "const": "Partnership" }, { "type": "string", "const": "Corporation" }, { "type": "string", "const": "Co-operative" }, { "type": "string", "const": "Limited Liability Corporation" }, { "type": "string", "const": "Non-profit Corporation" } ], "description": "The legal structure of the business: one of `Sole Proprietorship`, `Partnership`, `Corporation`, `Co-operative`, `Limited Liability Corporation`, `Non-profit Corporation`.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, "companyType": { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company. `ticker` and `exchange` are required when this is `Public`.", "examples": [ "Private" ], "example": "Private" }, "industry": { "anyOf": [ { "type": "string", "const": "Agriculture" }, { "type": "string", "const": "Automotive" }, { "type": "string", "const": "Banking" }, { "type": "string", "const": "Consumer" }, { "type": "string", "const": "Education" }, { "type": "string", "const": "Electronics" }, { "type": "string", "const": "Energy" }, { "type": "string", "const": "Engineering" }, { "type": "string", "const": "Fast moving consumer goods" }, { "type": "string", "const": "Financial" }, { "type": "string", "const": "Fintech" }, { "type": "string", "const": "Food and beverage" }, { "type": "string", "const": "Government" }, { "type": "string", "const": "Healthcare" }, { "type": "string", "const": "Hospitality" }, { "type": "string", "const": "Insurance" }, { "type": "string", "const": "Jewelry" }, { "type": "string", "const": "Legal" }, { "type": "string", "const": "Manufacturing" }, { "type": "string", "const": "Media" }, { "type": "string", "const": "Not for profit" }, { "type": "string", "const": "Oil and gas" }, { "type": "string", "const": "Online" }, { "type": "string", "const": "Raw materials" }, { "type": "string", "const": "Real estate" }, { "type": "string", "const": "Religion" }, { "type": "string", "const": "Retail" }, { "type": "string", "const": "Technology" }, { "type": "string", "const": "Telecommunications" }, { "type": "string", "const": "Transportation" }, { "type": "string", "const": "Travel" } ], "description": "The industry the business operates in: one of `Agriculture`, `Automotive`, `Banking`, `Consumer`, `Education`, `Electronics`, `Energy`, `Engineering`, `Fast moving consumer goods`, `Financial`, `Fintech`, `Food and beverage`, `Government`, `Healthcare`, `Hospitality`, `Insurance`, `Jewelry`, `Legal`, `Manufacturing`, `Media`, `Not for profit`, `Oil and gas`, `Online`, `Raw materials`, `Real estate`, `Religion`, `Retail`, `Technology`, `Telecommunications`, `Transportation`, `Travel`.", "examples": [ "Technology" ], "example": "Technology" }, "employeeCount": { "type": "integer", "minimum": 1, "description": "The number of employees at the business.", "examples": [ 25 ], "example": 25 }, "avgDailyCallVolume": { "type": "integer", "minimum": 1, "description": "The business's average daily call volume.", "examples": [ 100 ], "example": 100 }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "minItems": 1, "maxItems": 5, "uniqueItems": true, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`.", "examples": [ [ "USA and Canada" ] ], "example": [ "USA and Canada" ] }, "websiteUrl": { "type": "string", "minLength": 1, "maxLength": 255, "format": "uri", "description": "The business's website URL.", "examples": [ "https://acme.example" ], "example": "https://acme.example" }, "idType": { "anyOf": [ { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `USA: Employer Identification Number (EIN)`, `Canada: Canadian Business Number (BN-9)`, `Great Britain: Company Number`, `Australia: Company Number from ASIC (ACN)`, `India: Corporate Identity Number`, `Estonia: VAT Number`, `Romania: VAT Registration Number`, `Israel: Registration Number`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, "idNumber": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The business's government-issued tax ID number. An EIN must carry exactly nine digits, and separators such as the dash in `12-3456789` are ignored. A Canadian BN-9 must be exactly nine digits with no separators.", "examples": [ "12-3456789" ], "example": "12-3456789" }, "ticker": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "The business's stock ticker symbol. Required when `companyType` is `Public`.", "examples": [ "ACME" ], "example": "ACME" }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "NASDAQ" }, { "type": "string", "const": "NYSE" }, { "type": "string", "const": "AMEX" }, { "type": "string", "const": "AMX" }, { "type": "string", "const": "ASX" }, { "type": "string", "const": "B3" }, { "type": "string", "const": "BME" }, { "type": "string", "const": "BSE" }, { "type": "string", "const": "FRA" }, { "type": "string", "const": "ICEX" }, { "type": "string", "const": "JPX" }, { "type": "string", "const": "JSE" }, { "type": "string", "const": "KRX" }, { "type": "string", "const": "LON" }, { "type": "string", "const": "NSE" }, { "type": "string", "const": "OMX" }, { "type": "string", "const": "SEHK" }, { "type": "string", "const": "SGX" }, { "type": "string", "const": "SSE" }, { "type": "string", "const": "STO" }, { "type": "string", "const": "SWX" }, { "type": "string", "const": "SZSE" }, { "type": "string", "const": "TSX" }, { "type": "string", "const": "TWSE" }, { "type": "string", "const": "VSE" }, { "type": "string", "const": "Other" } ], "description": "The stock exchange the business's ticker is listed on. Required when `companyType` is `Public`. One of `NASDAQ`, `NYSE`, `AMEX`, `AMX`, `ASX`, `B3`, `BME`, `BSE`, `FRA`, `ICEX`, `JPX`, `JSE`, `KRX`, `LON`, `NSE`, `OMX`, `SEHK`, `SGX`, `SSE`, `STO`, `SWX`, `SZSE`, `TSX`, `TWSE`, `VSE`, `Other`.", "examples": [ "NASDAQ" ], "example": "NASDAQ" }, { "type": "null" } ] }, "address": { "type": "object", "properties": { "line1": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The first line of the business's registered address.", "examples": [ "1 Main St" ], "example": "1 Main St" }, "line2": { "anyOf": [ { "type": "string", "minLength": 1, "maxLength": 255, "description": "The second line of the business's registered address.", "examples": [ "Suite 200" ], "example": "Suite 200" }, { "type": "null" } ] }, "city": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The city of the business's registered address.", "examples": [ "San Francisco" ], "example": "San Francisco" }, "region": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The state or region of the business's registered address.", "examples": [ "CA" ], "example": "CA" }, "postalCode": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The postal code of the business's registered address.", "examples": [ "94110" ], "example": "94110" }, "country": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" } } }, "personOfContact": { "type": "object", "properties": { "firstName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The first name of the business contact submitting this registration.", "examples": [ "Ada" ], "example": "Ada" }, "lastName": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The last name of the business contact submitting this registration.", "examples": [ "Lovelace" ], "example": "Lovelace" }, "jobTitle": { "type": "string", "minLength": 1, "maxLength": 255, "description": "The job title of the business contact submitting this registration.", "examples": [ "CTO" ], "example": "CTO" }, "jobPosition": { "anyOf": [ { "type": "string", "const": "Other" }, { "type": "string", "const": "Director" }, { "type": "string", "const": "GM" }, { "type": "string", "const": "VP" }, { "type": "string", "const": "CEO" }, { "type": "string", "const": "CFO" }, { "type": "string", "const": "General Counsel" } ], "description": "The job position of the business contact submitting this registration: one of `Other`, `Director`, `GM`, `VP`, `CEO`, `CFO`, `General Counsel`.", "examples": [ "Director" ], "example": "Director" }, "email": { "type": "string", "minLength": 1, "maxLength": 255, "format": "email", "description": "The business contact's email address.", "examples": [ "ada@acme.example" ], "example": "ada@acme.example" }, "phoneNumber": { "type": "string", "maxLength": 255, "pattern": "^\\+[1-9]\\d{1,14}$", "description": "The business contact's phone number, in E.164 format.", "examples": [ "+15551234567" ], "example": "+15551234567" } } }, "messageTypes": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "appointments_scheduling" }, { "type": "string", "const": "transactional_notifications" }, { "type": "string", "const": "customer_support" }, { "type": "string", "const": "verification_security" }, { "type": "string", "const": "promotions_announcements" } ] }, "minItems": 1, "description": "The message-use types that autofill uses for this request. Required when the request includes `name`, `alternateName`, `businessType`, `websiteUrl`, `personOfContact.firstName` or `personOfContact.lastName`, because those fields start autofill. Ignored when the request includes none of them. To run autofill again, send one of them again with its current value. The registration does not store this value.", "examples": [ [ "customer_support", "transactional_notifications" ] ], "example": [ "customer_support", "transactional_notifications" ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "draft", "status", "statusMessages", "autofillStatus", "type", "assignedPnId", "firstSubmittedAt", "createdAt", "updatedAt", "businessInfo", "messaging" ], "properties": { "id": { "description": "The unique identifier of the A2P registration.", "examples": [ "RG123abc" ], "example": "RG123abc", "type": "string", "pattern": "^RG(.*)$" }, "draft": { "type": "boolean", "description": "True if the registration has not yet been submitted for carrier approval. Combine with `status` to tell submission states apart: `draft: true, status: \"pending\"` means not yet submitted; `draft: false, status: \"pending\"` means submitted and awaiting carrier approval." }, "status": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "approved" }, { "type": "string", "const": "rejected" }, { "type": "string", "const": "failed" } ], "description": "The registration's overall status. `pending` is set both at creation and while awaiting carrier approval after submission — check `draft` to tell those two apart. `rejected` and `failed` both mean the registration must be resubmitted, which re-triggers billing.", "examples": [ "pending" ], "example": "pending" }, "statusMessages": { "type": "array", "items": { "type": "object", "required": [ "errorCode", "errorReason" ], "properties": { "errorCode": { "type": "number", "description": "The carrier error code associated with this status message." }, "errorReason": { "type": "string", "description": "A human-readable explanation of the status." }, "fieldName": { "type": "string", "description": "The single business-profile field this message refers to, if any." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "The business-profile fields this message refers to, if any." } } }, "description": "Carrier-reported reasons for the current status, most relevant when `status` is `rejected` or `failed`." }, "autofillStatus": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "in-progress" }, { "type": "string", "const": "completed" }, { "type": "string", "const": "failed" } ], "description": "Status of the automatic field-fill for this registration. `completed` means the messaging fields are generated and the registration can be submitted; `pending` or `in-progress` means submission is not yet allowed; `failed` means autofill did not complete and the registration must be updated and retried.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "standard" }, { "type": "string", "const": "lv-standard" }, { "type": "string", "const": "starter" }, { "type": "string", "const": "sole-prop" } ], "description": "The type of A2P registration.", "examples": [ "standard" ], "example": "standard" }, { "type": "null" } ] }, "assignedPnId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "firstSubmittedAt": { "anyOf": [ { "description": "The timestamp the registration was first submitted for carrier approval.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp the registration was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp the registration was last updated.", "type": "string", "format": "date-time" }, "businessInfo": { "type": "object", "required": [ "name", "alternateName", "businessType", "companyType", "industry", "employeeCount", "avgDailyCallVolume", "regionsOfOperation", "websiteUrl", "idType", "idNumber", "ticker", "exchange", "address", "personOfContact" ], "properties": { "name": { "anyOf": [ { "type": "string", "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, { "type": "null" } ] }, "alternateName": { "anyOf": [ { "type": "string", "description": "An alternate or doing-business-as name for the business." }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "description": "The legal structure of the business.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company: one of `Private`, `Public`, `Non-profit`, `Government`.", "examples": [ "Private" ], "example": "Private" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "description": "The industry the business operates in." }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number", "description": "The number of employees at the business." }, { "type": "null" } ] }, "avgDailyCallVolume": { "anyOf": [ { "type": "number", "description": "The business's average daily call volume." }, { "type": "null" } ] }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`." }, "websiteUrl": { "anyOf": [ { "type": "string", "description": "The business's website URL.", "format": "uri" }, { "type": "null" } ] }, "idType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "Canada: Business Number (BIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Canada: Canadian Corporation Number (CCN)" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "USA: DUNS Number (Dun & Bradstreet)" }, { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `Australia: Company Number from ASIC (ACN)`, `Canada: Business Number (BIN)`, `Canada: Canadian Business Number (BN-9)`, `Canada: Canadian Corporation Number (CCN)`, `Estonia: VAT Number`, `Great Britain: Company Number`, `India: Corporate Identity Number`, `Israel: Registration Number`, `Romania: VAT Registration Number`, `USA: DUNS Number (Dun & Bradstreet)`, `USA: Employer Identification Number (EIN)`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, { "type": "null" } ] }, "idNumber": { "anyOf": [ { "type": "string", "description": "The business's government-issued tax ID number." }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string", "description": "The business's stock ticker symbol, if publicly traded." }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string", "description": "The stock exchange the business's ticker is listed on, if publicly traded." }, { "type": "null" } ] }, "address": { "type": "object", "required": [ "line1", "line2", "city", "region", "postalCode", "country" ], "properties": { "line1": { "anyOf": [ { "type": "string", "description": "The first line of the business's registered address." }, { "type": "null" } ] }, "line2": { "anyOf": [ { "type": "string", "description": "The second line of the business's registered address." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "The city of the business's registered address." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "The state or region of the business's registered address." }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string", "description": "The postal code of the business's registered address." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" }, { "type": "null" } ] } } }, "personOfContact": { "type": "object", "required": [ "firstName", "lastName", "jobTitle", "jobPosition", "email", "phoneNumber" ], "properties": { "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the business contact submitting this registration." }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the business contact submitting this registration." }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "description": "The job title of the business contact submitting this registration." }, { "type": "null" } ] }, "jobPosition": { "anyOf": [ { "type": "string", "description": "The job position of the business contact submitting this registration." }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "description": "The business contact's email address.", "format": "email" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string", "description": "The business contact's phone number." }, { "type": "null" } ] } } } } }, "messaging": { "type": "object", "required": [ "useCase", "personalUse", "consent" ], "properties": { "useCase": { "anyOf": [ { "type": "string", "description": "The messaging use case this registration was created for." }, { "type": "null" } ] }, "personalUse": { "anyOf": [ { "type": "boolean", "description": "Whether this registration is for an individual sending messages personally." }, { "type": "null" } ] }, "consent": { "anyOf": [ { "type": "object", "properties": { "digitalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "mobileApp": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "onSite": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "other": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "physicalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "textMessage": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "verbal": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "websiteForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "written": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You must be an organization admin or owner to update an A2P registration", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The organization has no A2P registration", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Conflict" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Registrations cannot be updated unless they are in draft status", "docs": "https://quo.com/docs", "title": "Conflict", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "idNumber must contain exactly nine digits for idType USA: Employer Identification Number (EIN)", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } } } } } } }, "/a2p-registration/submit": { "post": { "tags": [ "A2P Registration" ], "summary": "Submit the A2P registration", "description": "Submit the organization's A2P (10DLC) draft registration for carrier approval. Validates all fields and preconditions — including subscription status, draft state, and autofill completion — before attempting payment. Returns the updated registration object on success. Any payment outcome other than completed surfaces as a 402 error.", "operationId": "submitA2PRegistration", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "forbiddenMessageTopicsAcknowledged" ], "properties": { "forbiddenMessageTopicsAcknowledged": { "type": "boolean", "description": "Must be `true`. The caller acknowledges that they will not use the A2P service to send messages about forbidden topics. The request is rejected with 422 if this field is `false`. See https://support.quo.com/getting-started/carrier-registration/carrier-registration#registration-process for the registration process." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "draft", "status", "statusMessages", "autofillStatus", "type", "assignedPnId", "firstSubmittedAt", "createdAt", "updatedAt", "businessInfo", "messaging" ], "properties": { "id": { "description": "The unique identifier of the A2P registration.", "examples": [ "RG123abc" ], "example": "RG123abc", "type": "string", "pattern": "^RG(.*)$" }, "draft": { "type": "boolean", "description": "True if the registration has not yet been submitted for carrier approval. Combine with `status` to tell submission states apart: `draft: true, status: \"pending\"` means not yet submitted; `draft: false, status: \"pending\"` means submitted and awaiting carrier approval." }, "status": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "approved" }, { "type": "string", "const": "rejected" }, { "type": "string", "const": "failed" } ], "description": "The registration's overall status. `pending` is set both at creation and while awaiting carrier approval after submission — check `draft` to tell those two apart. `rejected` and `failed` both mean the registration must be resubmitted, which re-triggers billing.", "examples": [ "pending" ], "example": "pending" }, "statusMessages": { "type": "array", "items": { "type": "object", "required": [ "errorCode", "errorReason" ], "properties": { "errorCode": { "type": "number", "description": "The carrier error code associated with this status message." }, "errorReason": { "type": "string", "description": "A human-readable explanation of the status." }, "fieldName": { "type": "string", "description": "The single business-profile field this message refers to, if any." }, "fields": { "type": "array", "items": { "type": "string" }, "description": "The business-profile fields this message refers to, if any." } } }, "description": "Carrier-reported reasons for the current status, most relevant when `status` is `rejected` or `failed`." }, "autofillStatus": { "anyOf": [ { "type": "string", "const": "pending" }, { "type": "string", "const": "in-progress" }, { "type": "string", "const": "completed" }, { "type": "string", "const": "failed" } ], "description": "Status of the automatic field-fill for this registration. `completed` means the messaging fields are generated and the registration can be submitted; `pending` or `in-progress` means submission is not yet allowed; `failed` means autofill did not complete and the registration must be updated and retried.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "standard" }, { "type": "string", "const": "lv-standard" }, { "type": "string", "const": "starter" }, { "type": "string", "const": "sole-prop" } ], "description": "The type of A2P registration.", "examples": [ "standard" ], "example": "standard" }, { "type": "null" } ] }, "assignedPnId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "firstSubmittedAt": { "anyOf": [ { "description": "The timestamp the registration was first submitted for carrier approval.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp the registration was created.", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp the registration was last updated.", "type": "string", "format": "date-time" }, "businessInfo": { "type": "object", "required": [ "name", "alternateName", "businessType", "companyType", "industry", "employeeCount", "avgDailyCallVolume", "regionsOfOperation", "websiteUrl", "idType", "idNumber", "ticker", "exchange", "address", "personOfContact" ], "properties": { "name": { "anyOf": [ { "type": "string", "description": "The legal or registered name of the business.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, { "type": "null" } ] }, "alternateName": { "anyOf": [ { "type": "string", "description": "An alternate or doing-business-as name for the business." }, { "type": "null" } ] }, "businessType": { "anyOf": [ { "type": "string", "description": "The legal structure of the business.", "examples": [ "Limited Liability Corporation" ], "example": "Limited Liability Corporation" }, { "type": "null" } ] }, "companyType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Private" }, { "type": "string", "const": "Public" }, { "type": "string", "const": "Non-profit" }, { "type": "string", "const": "Government" } ], "description": "The type of company: one of `Private`, `Public`, `Non-profit`, `Government`.", "examples": [ "Private" ], "example": "Private" }, { "type": "null" } ] }, "industry": { "anyOf": [ { "type": "string", "description": "The industry the business operates in." }, { "type": "null" } ] }, "employeeCount": { "anyOf": [ { "type": "number", "description": "The number of employees at the business." }, { "type": "null" } ] }, "avgDailyCallVolume": { "anyOf": [ { "type": "number", "description": "The business's average daily call volume." }, { "type": "null" } ] }, "regionsOfOperation": { "type": "array", "items": { "anyOf": [ { "type": "string", "const": "Africa" }, { "type": "string", "const": "Asia" }, { "type": "string", "const": "Europe" }, { "type": "string", "const": "Latin America" }, { "type": "string", "const": "USA and Canada" } ] }, "description": "The regions the business operates in. Each entry is one of `Africa`, `Asia`, `Europe`, `Latin America`, `USA and Canada`." }, "websiteUrl": { "anyOf": [ { "type": "string", "description": "The business's website URL.", "format": "uri" }, { "type": "null" } ] }, "idType": { "anyOf": [ { "anyOf": [ { "type": "string", "const": "Australia: Company Number from ASIC (ACN)" }, { "type": "string", "const": "Canada: Business Number (BIN)" }, { "type": "string", "const": "Canada: Canadian Business Number (BN-9)" }, { "type": "string", "const": "Canada: Canadian Corporation Number (CCN)" }, { "type": "string", "const": "Estonia: VAT Number" }, { "type": "string", "const": "Great Britain: Company Number" }, { "type": "string", "const": "India: Corporate Identity Number" }, { "type": "string", "const": "Israel: Registration Number" }, { "type": "string", "const": "Romania: VAT Registration Number" }, { "type": "string", "const": "USA: DUNS Number (Dun & Bradstreet)" }, { "type": "string", "const": "USA: Employer Identification Number (EIN)" }, { "type": "string", "const": "Other" } ], "description": "The type of the business's government-issued tax ID: one of `Australia: Company Number from ASIC (ACN)`, `Canada: Business Number (BIN)`, `Canada: Canadian Business Number (BN-9)`, `Canada: Canadian Corporation Number (CCN)`, `Estonia: VAT Number`, `Great Britain: Company Number`, `India: Corporate Identity Number`, `Israel: Registration Number`, `Romania: VAT Registration Number`, `USA: DUNS Number (Dun & Bradstreet)`, `USA: Employer Identification Number (EIN)`, `Other`.", "examples": [ "USA: Employer Identification Number (EIN)" ], "example": "USA: Employer Identification Number (EIN)" }, { "type": "null" } ] }, "idNumber": { "anyOf": [ { "type": "string", "description": "The business's government-issued tax ID number." }, { "type": "null" } ] }, "ticker": { "anyOf": [ { "type": "string", "description": "The business's stock ticker symbol, if publicly traded." }, { "type": "null" } ] }, "exchange": { "anyOf": [ { "type": "string", "description": "The stock exchange the business's ticker is listed on, if publicly traded." }, { "type": "null" } ] }, "address": { "type": "object", "required": [ "line1", "line2", "city", "region", "postalCode", "country" ], "properties": { "line1": { "anyOf": [ { "type": "string", "description": "The first line of the business's registered address." }, { "type": "null" } ] }, "line2": { "anyOf": [ { "type": "string", "description": "The second line of the business's registered address." }, { "type": "null" } ] }, "city": { "anyOf": [ { "type": "string", "description": "The city of the business's registered address." }, { "type": "null" } ] }, "region": { "anyOf": [ { "type": "string", "description": "The state or region of the business's registered address." }, { "type": "null" } ] }, "postalCode": { "anyOf": [ { "type": "string", "description": "The postal code of the business's registered address." }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string", "description": "The country of the business's registered address.", "examples": [ "US" ], "example": "US" }, { "type": "null" } ] } } }, "personOfContact": { "type": "object", "required": [ "firstName", "lastName", "jobTitle", "jobPosition", "email", "phoneNumber" ], "properties": { "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the business contact submitting this registration." }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the business contact submitting this registration." }, { "type": "null" } ] }, "jobTitle": { "anyOf": [ { "type": "string", "description": "The job title of the business contact submitting this registration." }, { "type": "null" } ] }, "jobPosition": { "anyOf": [ { "type": "string", "description": "The job position of the business contact submitting this registration." }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string", "description": "The business contact's email address.", "format": "email" }, { "type": "null" } ] }, "phoneNumber": { "anyOf": [ { "type": "string", "description": "The business contact's phone number." }, { "type": "null" } ] } } } } }, "messaging": { "type": "object", "required": [ "useCase", "personalUse", "consent" ], "properties": { "useCase": { "anyOf": [ { "type": "string", "description": "The messaging use case this registration was created for." }, { "type": "null" } ] }, "personalUse": { "anyOf": [ { "type": "boolean", "description": "Whether this registration is for an individual sending messages personally." }, { "type": "null" } ] }, "consent": { "anyOf": [ { "type": "object", "properties": { "digitalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "mobileApp": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "onSite": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "other": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "physicalForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "textMessage": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "verbal": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "websiteForm": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } }, "written": { "type": "object", "required": [ "enabled" ], "properties": { "enabled": { "type": "boolean", "description": "Whether this consent channel is in use." }, "askForConsentExample": { "type": "string", "description": "An example of how consent is requested through this channel." }, "screenshotUrl": { "type": "string", "description": "A screenshot demonstrating this consent channel." }, "storeUrl": { "type": "string", "description": "The app store URL for this consent channel." }, "text": { "type": "string", "description": "The consent text shown to the end user through this channel." }, "url": { "type": "string", "description": "A URL demonstrating or hosting this consent channel." } } } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Subscription Expired | Payment Failed", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/SubscriptionExpiredError" }, { "$ref": "#/components/schemas/PaymentFailedError" } ] }, "examples": { "SubscriptionExpiredError": { "summary": "Subscription Expired", "value": { "message": "This subscription is not able to register for A2P", "docs": "https://quo.com/docs", "title": "Subscription Expired", "trace": "6897907457496870895" } }, "PaymentFailedError": { "summary": "Payment Failed", "value": { "message": "Payment could not be completed. Check your billing details and any open invoices in the app, then try again.", "docs": "https://quo.com/docs", "title": "Payment Failed", "trace": "6897907457496870895" } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You must be an organization admin or owner to submit an A2P registration", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The organization has no A2P registration", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Conflict" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Autofill is still running — try again shortly", "docs": "https://quo.com/docs", "title": "Conflict", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "forbiddenMessageTopicsAcknowledged must be true to submit", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } } } } } } }, "/calls": { "get": { "tags": [ "Calls" ], "summary": "List calls", "description": "Fetch a paginated list of calls in the workspace, newest first. With an OAuth token, only calls on the phone numbers the user is a member of are returned. Every filter is optional, and group calls are included.", "operationId": "listCalls", "parameters": [ { "in": "query", "name": "include", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "summary", "voicemail" ] }, "description": "Comma-separated list of optional payload sections to include. `summary` adds the call’s summary, `voicemail` the voicemail left on it. Omitted sections are left out of the response entirely, and `voicemail` is also left out for a call where none was left.", "examples": [ "summary", "summary,voicemail" ], "maxItems": 2, "uniqueItems": true }, "example": "summary" }, { "in": "query", "name": "phoneNumberId", "required": false, "schema": { "description": "Only return calls on this Quo number. With an OAuth token, a number the user is not a member of returns no calls.", "examples": [ "PN123abc" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PN123abc" }, { "in": "query", "name": "actorId", "required": false, "schema": { "description": "Only return calls belonging to this Quo user or system actor. An AI agent is a system actor, so its calls are reached with its `SYU` id.", "examples": [ "US123abc" ], "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, "example": "US123abc" }, { "in": "query", "name": "participant", "required": false, "schema": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$" }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$" }, "description": "Match calls involving any of these numbers.", "examples": [ "+15555555555,+15555555556" ] } }, "additionalProperties": false } ], "description": "Only return calls whose own originating or receiving number is this E.164 number, such as `participant=+15555555555`. To match any of several numbers, use `participant[in]=+15555555555,+15555555556`. Note that this is narrower than the `participants` array in the response: a party who joined a group call beyond those two numbers is listed in the response but is not matched by this filter.", "examples": [ "+15555555555" ] }, "style": "deepObject", "explode": true, "example": "+15555555555" }, { "in": "query", "name": "direction", "required": false, "schema": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the call relative to the Quo number.", "examples": [ "incoming" ] }, "example": "incoming" }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "queued", "initiated", "ringing", "in-progress", "completed", "busy", "failed", "no-answer", "canceled", "missed", "answered", "forwarded", "abandoned" ], "description": "The current status of the call.", "examples": [ "completed" ] }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string", "enum": [ "queued", "initiated", "ringing", "in-progress", "completed", "busy", "failed", "no-answer", "canceled", "missed", "answered", "forwarded", "abandoned" ], "description": "The current status of the call.", "examples": [ "completed" ] }, "description": "Match calls with any of these statuses.", "examples": [ "missed,no-answer" ] } }, "additionalProperties": false } ], "description": "Only return calls with this status, such as `status=missed`. To match any of several statuses, use `status[in]=missed,no-answer`.", "examples": [ "missed" ] }, "style": "deepObject", "explode": true, "example": "missed" }, { "in": "query", "name": "createdAt", "required": false, "schema": { "type": "object", "properties": { "gte": { "description": "Only return calls created at or after this timestamp. The bound is inclusive.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "lte": { "description": "Only return calls created at or before this timestamp. The bound is inclusive.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Bound the results by creation time, in ISO 8601 format: `createdAt[gte]=2022-01-01T00:00:00Z&createdAt[lte]=2022-02-01T00:00:00Z`. Both bounds are inclusive.", "examples": [ { "gte": "2022-01-01T00:00:00Z" } ] }, "style": "deepObject", "explode": true, "example": { "gte": "2022-01-01T00:00:00Z" } }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "phoneNumberId", "actorId", "direction", "status", "participants", "answeredAt", "answeredBy", "initiatedBy", "completedAt", "createdAt", "updatedAt", "callRoute", "duration", "forwardedFrom", "forwardedTo", "aiHandled" ], "properties": { "id": { "description": "The unique identifier of the call.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo number associated with the call. Null when the call is not attached to one.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "actorId": { "description": "The Quo user or system actor associated with the call.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the call relative to the Quo number.", "examples": [ "incoming" ], "example": "incoming" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "in-progress", "completed", "busy", "failed", "no-answer", "canceled", "missed", "answered", "forwarded", "abandoned" ], "description": "The current status of the call.", "examples": [ "completed" ], "example": "completed" }, "participants": { "type": "array", "items": { "type": "object", "required": [ "phoneNumber", "actorId" ], "properties": { "phoneNumber": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" } ], "description": "How the participant reached the call: an E.164 phone number, `anonymous`/`blocked`/`restricted` when the caller withheld their number, or a short service number.", "examples": [ "+15555555555" ], "example": "+15555555555" }, "actorId": { "anyOf": [ { "description": "The Quo user or system actor behind this number. Null for numbers outside the workspace. A system actor appears here when an AI agent took part in the call.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] } } }, "description": "Every party on the call, including the Quo number. Group calls return all known parties, so this is not limited to two entries. A phone number can appear more than once when several Quo users joined the call on it, distinguished by `actorId`.", "examples": [ [ { "phoneNumber": "+15555555555", "actorId": "US123abc" }, { "phoneNumber": "+15555555555", "actorId": "US456def" }, { "phoneNumber": "+15555555556", "actorId": null } ] ], "example": [ { "phoneNumber": "+15555555555", "actorId": "US123abc" }, { "phoneNumber": "+15555555555", "actorId": "US456def" }, { "phoneNumber": "+15555555556", "actorId": null } ] }, "answeredAt": { "anyOf": [ { "description": "The timestamp when the call was answered, in ISO 8601 format. Null if the call was never answered.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "answeredBy": { "anyOf": [ { "description": "The Quo user or system actor that answered the incoming call. Null for outgoing calls or unanswered incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "initiatedBy": { "anyOf": [ { "description": "The Quo user or system actor that initiated the outgoing call. Null for incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "description": "The timestamp when the call ended, in ISO 8601 format. Null if the call is ongoing or was not completed.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp when the call record was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "anyOf": [ { "description": "The timestamp when the call record was last updated, in ISO 8601 format. Null if never updated.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "callRoute": { "anyOf": [ { "description": "How the call reached the user's inbox: either by direct dial to their number or routed through a phone menu. Null for outbound calls.", "examples": [ "phone-number", "phone-menu" ], "example": "phone-number", "type": "string" }, { "type": "null" } ] }, "duration": { "type": "integer", "description": "The total duration of the call in seconds.", "examples": [ 60 ], "example": 60 }, "forwardedFrom": { "anyOf": [ { "description": "Where the call was forwarded from: an E.164 phone number, a Quo user or phone number ID, a marker for a withheld caller (`anonymous`, `blocked`, `restricted`), or a short service number. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^PN(.*)$" }, { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "A short service or emergency number, such as `911` or `611`.", "examples": [ "911" ], "pattern": "^\\d{3,6}$", "example": "911" } ] }, { "type": "null" } ] }, "forwardedTo": { "anyOf": [ { "description": "Where the call was forwarded to: an E.164 phone number, a Quo user or phone number ID, a marker for a withheld caller (`anonymous`, `blocked`, `restricted`), or a short service number. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^PN(.*)$" }, { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "A short service or emergency number, such as `911` or `611`.", "examples": [ "911" ], "pattern": "^\\d{3,6}$", "example": "911" } ] }, { "type": "null" } ] }, "aiHandled": { "anyOf": [ { "description": "Type of AI that answered the call. Set to 'ai-agent' for AI responses, or null for human responses.", "examples": [ "ai-agent" ], "example": "ai-agent", "type": "string" }, { "type": "null" } ] }, "summary": { "type": "object", "required": [ "status", "type", "summary", "nextSteps", "jobs", "title" ], "properties": { "status": { "type": "string", "enum": [ "absent", "in-progress", "completed", "failed" ], "description": "Whether a summary exists for this call. `absent` means one will never be generated, `in-progress` that it is still being written, and `failed` that generation was attempted and did not succeed. Content is only present when this is `completed`.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "type": "string", "enum": [ "human", "agent" ], "description": "Which kind of call produced the summary. `agent` calls were handled by AI agent and carry `jobs` and a `title`; `human` calls carry `nextSteps`. Null until a summary exists.", "examples": [ "human" ], "example": "human" }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "You talked about the weather." ], "example": "You talked about the weather." }, "description": "The key points discussed during the call. Null when no summary has been generated." }, { "type": "null" } ] }, "nextSteps": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "Bring an umbrella." ], "example": "Bring an umbrella." }, "description": "Suggested follow-up items derived from the call. Only produced for `human` summaries; null otherwise." }, { "type": "null" } ] }, "jobs": { "anyOf": [ { "description": "Structured job results collected by AI Agent — Q&A pairs, task completions and similar. Only produced for `agent` summaries; null otherwise.", "type": "array", "items": { "type": "object", "required": [ "icon", "name", "result" ], "properties": { "icon": { "type": "string" }, "name": { "type": "string" }, "result": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } } } } } } }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "description": "A short title for the call. Only produced for `agent` summaries; null otherwise.", "examples": [ "Pricing enquiry" ], "example": "Pricing enquiry" }, { "type": "null" } ] } } }, "voicemail": { "type": "object", "required": [ "id", "status", "duration", "recordingUrl", "transcript" ], "properties": { "id": { "description": "The unique identifier of the voicemail.", "examples": [ "VMaaff8f317e0c4e61953b74a5eb42a370" ], "example": "VMaaff8f317e0c4e61953b74a5eb42a370", "type": "string", "pattern": "^VM(.*)$" }, "status": { "type": "string", "enum": [ "completed", "in-progress" ], "description": "Whether the voicemail has finished processing. `recordingUrl` and `transcript` are only present once this is `completed`.", "examples": [ "completed" ], "example": "completed" }, "duration": { "anyOf": [ { "type": "integer", "description": "The length of the voicemail in seconds. Known as soon as the recording is captured, so it is usually available before processing finishes.", "examples": [ 60 ], "example": 60 }, { "type": "null" } ] }, "recordingUrl": { "anyOf": [ { "type": "string", "description": "The URL the voicemail audio can be downloaded from. Null until the voicemail is completed.", "examples": [ "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" ], "format": "uri", "example": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" }, { "type": "null" } ] }, "transcript": { "anyOf": [ { "type": "string", "description": "The transcript of the voicemail. Null until the voicemail is completed, and null afterwards when transcription is turned off for the phone number that took the call.", "examples": [ "Hello, this is a voicemail from John Doe." ], "example": "Hello, this is a voicemail from John Doe." }, { "type": "null" } ] } } } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/callId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/calls/{callId}": { "get": { "tags": [ "Calls" ], "summary": "Get a call by ID", "description": "Get a call by its unique identifier.", "operationId": "getCallById", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "Unique identifier of the call.", "examples": [ "AC3700e624eca547eb9f749a06f2eb1" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f2eb1" }, { "in": "query", "name": "include", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "summary", "voicemail" ] }, "description": "Comma-separated list of optional payload sections to include. `summary` adds the call’s summary, `voicemail` the voicemail left on it. Omitted sections are left out of the response entirely, and `voicemail` is also left out for a call where none was left.", "examples": [ "summary", "summary,voicemail" ], "maxItems": 2, "uniqueItems": true }, "example": "summary" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "phoneNumberId", "actorId", "direction", "status", "participants", "answeredAt", "answeredBy", "initiatedBy", "completedAt", "createdAt", "updatedAt", "callRoute", "duration", "forwardedFrom", "forwardedTo", "aiHandled" ], "properties": { "id": { "description": "The unique identifier of the call.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo number associated with the call. Null when the call is not attached to one.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "actorId": { "description": "The Quo user or system actor associated with the call.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the call relative to the Quo number.", "examples": [ "incoming" ], "example": "incoming" }, "status": { "type": "string", "enum": [ "queued", "initiated", "ringing", "in-progress", "completed", "busy", "failed", "no-answer", "canceled", "missed", "answered", "forwarded", "abandoned" ], "description": "The current status of the call.", "examples": [ "completed" ], "example": "completed" }, "participants": { "type": "array", "items": { "type": "object", "required": [ "phoneNumber", "actorId" ], "properties": { "phoneNumber": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" } ], "description": "How the participant reached the call: an E.164 phone number, `anonymous`/`blocked`/`restricted` when the caller withheld their number, or a short service number.", "examples": [ "+15555555555" ], "example": "+15555555555" }, "actorId": { "anyOf": [ { "description": "The Quo user or system actor behind this number. Null for numbers outside the workspace. A system actor appears here when an AI agent took part in the call.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] } } }, "description": "Every party on the call, including the Quo number. Group calls return all known parties, so this is not limited to two entries. A phone number can appear more than once when several Quo users joined the call on it, distinguished by `actorId`.", "examples": [ [ { "phoneNumber": "+15555555555", "actorId": "US123abc" }, { "phoneNumber": "+15555555555", "actorId": "US456def" }, { "phoneNumber": "+15555555556", "actorId": null } ] ], "example": [ { "phoneNumber": "+15555555555", "actorId": "US123abc" }, { "phoneNumber": "+15555555555", "actorId": "US456def" }, { "phoneNumber": "+15555555556", "actorId": null } ] }, "answeredAt": { "anyOf": [ { "description": "The timestamp when the call was answered, in ISO 8601 format. Null if the call was never answered.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "answeredBy": { "anyOf": [ { "description": "The Quo user or system actor that answered the incoming call. Null for outgoing calls or unanswered incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "initiatedBy": { "anyOf": [ { "description": "The Quo user or system actor that initiated the outgoing call. Null for incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "completedAt": { "anyOf": [ { "description": "The timestamp when the call ended, in ISO 8601 format. Null if the call is ongoing or was not completed.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp when the call record was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "anyOf": [ { "description": "The timestamp when the call record was last updated, in ISO 8601 format. Null if never updated.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "callRoute": { "anyOf": [ { "description": "How the call reached the user's inbox: either by direct dial to their number or routed through a phone menu. Null for outbound calls.", "examples": [ "phone-number", "phone-menu" ], "example": "phone-number", "type": "string" }, { "type": "null" } ] }, "duration": { "type": "integer", "description": "The total duration of the call in seconds.", "examples": [ 60 ], "example": 60 }, "forwardedFrom": { "anyOf": [ { "description": "Where the call was forwarded from: an E.164 phone number, a Quo user or phone number ID, a marker for a withheld caller (`anonymous`, `blocked`, `restricted`), or a short service number. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^PN(.*)$" }, { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "A short service or emergency number, such as `911` or `611`.", "examples": [ "911" ], "pattern": "^\\d{3,6}$", "example": "911" } ] }, { "type": "null" } ] }, "forwardedTo": { "anyOf": [ { "description": "Where the call was forwarded to: an E.164 phone number, a Quo user or phone number ID, a marker for a withheld caller (`anonymous`, `blocked`, `restricted`), or a short service number. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "pattern": "^PN(.*)$" }, { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string", "description": "A short service or emergency number, such as `911` or `611`.", "examples": [ "911" ], "pattern": "^\\d{3,6}$", "example": "911" } ] }, { "type": "null" } ] }, "aiHandled": { "anyOf": [ { "description": "Type of AI that answered the call. Set to 'ai-agent' for AI responses, or null for human responses.", "examples": [ "ai-agent" ], "example": "ai-agent", "type": "string" }, { "type": "null" } ] }, "summary": { "type": "object", "required": [ "status", "type", "summary", "nextSteps", "jobs", "title" ], "properties": { "status": { "type": "string", "enum": [ "absent", "in-progress", "completed", "failed" ], "description": "Whether a summary exists for this call. `absent` means one will never be generated, `in-progress` that it is still being written, and `failed` that generation was attempted and did not succeed. Content is only present when this is `completed`.", "examples": [ "completed" ], "example": "completed" }, "type": { "anyOf": [ { "type": "string", "enum": [ "human", "agent" ], "description": "Which kind of call produced the summary. `agent` calls were handled by AI agent and carry `jobs` and a `title`; `human` calls carry `nextSteps`. Null until a summary exists.", "examples": [ "human" ], "example": "human" }, { "type": "null" } ] }, "summary": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "You talked about the weather." ], "example": "You talked about the weather." }, "description": "The key points discussed during the call. Null when no summary has been generated." }, { "type": "null" } ] }, "nextSteps": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "Bring an umbrella." ], "example": "Bring an umbrella." }, "description": "Suggested follow-up items derived from the call. Only produced for `human` summaries; null otherwise." }, { "type": "null" } ] }, "jobs": { "anyOf": [ { "description": "Structured job results collected by AI Agent — Q&A pairs, task completions and similar. Only produced for `agent` summaries; null otherwise.", "type": "array", "items": { "type": "object", "required": [ "icon", "name", "result" ], "properties": { "icon": { "type": "string" }, "name": { "type": "string" }, "result": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "boolean" } ] } } } } } } } } }, { "type": "null" } ] }, "title": { "anyOf": [ { "type": "string", "description": "A short title for the call. Only produced for `agent` summaries; null otherwise.", "examples": [ "Pricing enquiry" ], "example": "Pricing enquiry" }, { "type": "null" } ] } } }, "voicemail": { "type": "object", "required": [ "id", "status", "duration", "recordingUrl", "transcript" ], "properties": { "id": { "description": "The unique identifier of the voicemail.", "examples": [ "VMaaff8f317e0c4e61953b74a5eb42a370" ], "example": "VMaaff8f317e0c4e61953b74a5eb42a370", "type": "string", "pattern": "^VM(.*)$" }, "status": { "type": "string", "enum": [ "completed", "in-progress" ], "description": "Whether the voicemail has finished processing. `recordingUrl` and `transcript` are only present once this is `completed`.", "examples": [ "completed" ], "example": "completed" }, "duration": { "anyOf": [ { "type": "integer", "description": "The length of the voicemail in seconds. Known as soon as the recording is captured, so it is usually available before processing finishes.", "examples": [ 60 ], "example": 60 }, { "type": "null" } ] }, "recordingUrl": { "anyOf": [ { "type": "string", "description": "The URL the voicemail audio can be downloaded from. Null until the voicemail is completed.", "examples": [ "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" ], "format": "uri", "example": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" }, { "type": "null" } ] }, "transcript": { "anyOf": [ { "type": "string", "description": "The transcript of the voicemail. Null until the voicemail is completed, and null afterwards when transcription is turned off for the phone number that took the call.", "examples": [ "Hello, this is a voicemail from John Doe." ], "example": "Hello, this is a voicemail from John Doe." }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/callId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Call not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/calls/{callId}/recordings": { "get": { "tags": [ "Calls" ], "summary": "List recordings for a call", "description": "Fetch a paginated list of a call's recordings. Unlike most list endpoints, which default to newest first, recordings are sorted by `startTime` ascending, so the oldest segment of the call comes first. A call that was paused and resumed has one recording per recorded segment, so a single call can return several.", "operationId": "getCallRecordings", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "The unique identifier of the call whose recordings are being listed.", "examples": [ "AC3700e624eca547eb9f749a06f2eb1" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f2eb1" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "status", "startTime", "duration", "url", "type" ], "properties": { "id": { "description": "The unique identifier of the recording.", "examples": [ "CRwRVK2qBq" ], "example": "CRwRVK2qBq", "type": "string", "pattern": "^CR(.*)$" }, "status": { "type": "string", "enum": [ "absent", "completed", "deleted", "failed", "in-progress", "paused", "processing", "stopped", "stopping" ], "description": "The current status of the recording.", "examples": [ "completed" ], "example": "completed" }, "startTime": { "description": "The timestamp when this recording started, in ISO 8601 format. Recordings are returned in this order, oldest segment first.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "duration": { "anyOf": [ { "type": "integer", "description": "The length of the recording in seconds. Null while the length is not yet known.", "examples": [ 60 ], "example": 60 }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string", "description": "A signed URL for the recording audio. Null until the recording reaches the `completed` status.", "examples": [ "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" ], "format": "uri-reference", "example": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the file `url` points at. Null whenever `url` is null.", "examples": [ "audio/mpeg" ], "example": "audio/mpeg" }, { "type": "null" } ] } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/callId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Call not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/calls/{callId}/transcripts": { "get": { "tags": [ "Calls" ], "summary": "List transcripts for a call", "description": "Fetch a paginated list of a call's transcripts. Unlike most list endpoints, which default to newest first, transcripts are sorted by `startTime` ascending, so the oldest segment of the call comes first. A call that was paused and resumed has one recording per recorded segment, and one transcript per recording, so a single call can return several.", "operationId": "getCallTranscripts", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "The unique identifier of the call whose transcripts are being listed.", "examples": [ "AC3700e624eca547eb9f749a06f2eb1" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f2eb1" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "recordingId", "status", "startTime", "createdAt", "duration", "dialogue" ], "properties": { "recordingId": { "description": "The recording this transcript was produced from.", "examples": [ "CRwRVK2qBq" ], "example": "CRwRVK2qBq", "type": "string", "pattern": "^CR(.*)$" }, "status": { "type": "string", "enum": [ "absent", "in-progress", "completed", "failed" ], "description": "The transcription status of the recording this transcript was produced from. `absent` means one will never be produced, `in-progress` that transcription is still running, and `failed` that it was attempted and did not succeed. `dialogue` is only populated once this is `completed`.", "examples": [ "completed" ], "example": "completed" }, "startTime": { "description": "The timestamp when the recording this transcript came from started, in ISO 8601 format. Transcripts are returned in this order, oldest segment first.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "createdAt": { "description": "The timestamp when this transcript was produced, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "duration": { "type": "number", "description": "The duration of the transcribed audio in seconds.", "examples": [ 100 ], "example": 100 }, "dialogue": { "type": "array", "items": { "type": "object", "required": [ "content", "start", "end", "identifier", "actorId" ], "properties": { "content": { "type": "string", "description": "The transcribed text of this dialogue segment.", "examples": [ "Hello, world!" ], "example": "Hello, world!" }, "start": { "type": "number", "description": "When this dialogue segment starts, in seconds from the start of its own recording.", "examples": [ 5.123456 ], "example": 5.123456 }, "end": { "type": "number", "description": "When this dialogue segment ends, in seconds from the start of its own recording.", "examples": [ 10.123456 ], "example": 10.123456 }, "identifier": { "anyOf": [ { "type": "string", "description": "The phone number of the participant who spoke during this dialogue segment.", "examples": [ "+19876543210" ], "example": "+19876543210" }, { "type": "null" } ] }, "actorId": { "anyOf": [ { "description": "The Quo user or system actor who spoke during this dialogue segment. Null for external participants, and when the speaker could not be identified.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] } } }, "description": "The transcribed conversation, in the order it was spoken." } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/callId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Call not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List contacts", "description": "Get a paginated list of contacts.", "operationId": "listContacts", "parameters": [ { "in": "query", "name": "externalId", "required": false, "schema": { "anyOf": [ { "anyOf": [ { "type": "string", "examples": [ "ext-1" ] }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "description": "Match contacts carrying any of these external IDs.", "maxItems": 50, "examples": [ "ext-1", "ext-1,ext-2" ] } }, "additionalProperties": false } ], "description": "Filter by external ID, such as `externalId=ext-1`. To match any of several, use `externalId[in]=ext-1,ext-2`.", "examples": [ "ext-1" ] }, { "type": "null" } ] }, "style": "deepObject", "explode": true }, { "in": "query", "name": "source", "required": false, "schema": { "anyOf": [ { "anyOf": [ { "type": "string", "examples": [ "openphone-hubspot" ] }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string" }, "description": "Match contacts carrying any of these source labels.", "maxItems": 50, "examples": [ "openphone-hubspot", "openphone-salesforce", "openphone-salesforce,openphone-hubspot" ] } }, "additionalProperties": false } ], "description": "Filter by source label, such as `source=openphone-hubspot`. To match any of several, use `source[in]=openphone-hubspot,openphone-salesforce`.", "examples": [ "openphone-hubspot" ] }, { "type": "null" } ] }, "style": "deepObject", "explode": true }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50, "default": 10, "description": "Page size" }, { "type": "null" } ] } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, { "type": "null" } ] } }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "1234567890" ], "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "public-api" ], "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the contact.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "admin" ], "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a contact", "description": "Create a new contact in the organization.", "operationId": "createContact", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName" ], "properties": { "firstName": { "type": "string", "description": "The first name of the contact.", "examples": [ "Alice" ], "example": "Alice" }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Johnson" ], "example": "Johnson" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Acme Corp" ], "example": "Acme Corp" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "CEO" ], "example": "CEO" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "external-001" ], "example": "external-001" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "external" ], "example": "external" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "actorId": { "anyOf": [ { "description": "The actor ID to attribute contact creation to. Defaults to the organization owner.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "1234567890" ], "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "public-api" ], "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the contact.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "admin" ], "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Conflict" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Failed to create contact because a contact with the same source and external ID already exists", "docs": "https://quo.com/docs", "title": "Conflict", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}": { "get": { "tags": [ "Contacts" ], "summary": "Get a contact by ID", "description": "Retrieve detailed information about a specific contact in your Quo workspace using the contact's unique identifier.", "operationId": "getContactById", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact being retrieved.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "1234567890" ], "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "public-api" ], "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the contact.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "admin" ], "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a contact", "description": "Delete a contact from the organization by its unique identifier.", "operationId": "deleteContact", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact to delete.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a contact by ID", "description": "Update a contact by ID.", "operationId": "updateContactById", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact being updated.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the contact.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "admin" ], "example": "admin" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "1234567890" ], "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "public-api" ], "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "The source URL of the contact.", "examples": [ "https://my.quo.com/contacts/6a145ff26212a192852c856e" ], "example": "https://my.quo.com/contacts/6a145ff26212a192852c856e" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "The external ID of the contact.", "examples": [ "1234567890" ], "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "The source of the contact.", "examples": [ "public-api" ], "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "type": "string", "description": "The first name of the contact.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The last name of the contact.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "type": "string", "description": "The company of the contact.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "type": "string", "description": "The role of the contact.", "examples": [ "admin" ], "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Conflict" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Failed to create contact because a contact with the same source and external ID already exists", "docs": "https://quo.com/docs", "title": "Conflict", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}/notes": { "get": { "tags": [ "Contact Notes" ], "summary": "List notes for a contact", "description": "Get a paginated list of a contact's notes.", "operationId": "listContactNotes", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact whose notes are being listed.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "text", "media", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the note.", "examples": [ "6a145ff26212a192852c856f" ], "example": "6a145ff26212a192852c856f", "type": "string", "pattern": "^(.*)$" }, "text": { "type": "string", "description": "The body of the note.", "examples": [ "Please follow up with the customer." ], "example": "Please follow up with the customer." }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" ], "example": "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The file name of the attached media.", "examples": [ "an_image.png" ], "example": "an_image.png" }, { "type": "null" } ] } } }, "description": "Attachments on the note." }, "createdAt": { "description": "The timestamp of the note creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the note update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID that authored the note.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "post": { "tags": [ "Contact Notes" ], "summary": "Create a contact note", "description": "Add a new note to a contact. Mentions using the @USxxx / @GRxxx / @ORxxx tag syntax in the note text are automatically detected and resolved.", "operationId": "createContactNote", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact whose notes are being listed.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "minLength": 1, "maxLength": 2000, "description": "The body of the note. Mentions using the @USxxx / @GRxxx / @ORxxx tag syntax are automatically detected and resolved.", "examples": [ "@USabc321 can you follow up on this please?" ], "example": "@USabc321 can you follow up on this please?" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "text", "media", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the note.", "examples": [ "6a145ff26212a192852c856f" ], "example": "6a145ff26212a192852c856f", "type": "string", "pattern": "^(.*)$" }, "text": { "type": "string", "description": "The body of the note.", "examples": [ "Please follow up with the customer." ], "example": "Please follow up with the customer." }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" ], "example": "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The file name of the attached media.", "examples": [ "an_image.png" ], "example": "an_image.png" }, { "type": "null" } ] } } }, "description": "Attachments on the note." }, "createdAt": { "description": "The timestamp of the note creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the note update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID that authored the note.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}/notes/{noteId}": { "get": { "tags": [ "Contact Notes" ], "summary": "Get a contact note by ID", "description": "Retrieve a single note for a contact using the note's unique identifier.", "operationId": "getContactNote", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact the note belongs to.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "noteId", "required": true, "schema": { "description": "The unique identifier of the note to retrieve.", "examples": [ "6a145ff26212a192852c856f" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856f" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "text", "media", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the note.", "examples": [ "6a145ff26212a192852c856f" ], "example": "6a145ff26212a192852c856f", "type": "string", "pattern": "^(.*)$" }, "text": { "type": "string", "description": "The body of the note.", "examples": [ "Please follow up with the customer." ], "example": "Please follow up with the customer." }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" ], "example": "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The file name of the attached media.", "examples": [ "an_image.png" ], "example": "an_image.png" }, { "type": "null" } ] } } }, "description": "Attachments on the note." }, "createdAt": { "description": "The timestamp of the note creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the note update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID that authored the note.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Contact Notes" ], "summary": "Delete a contact note", "description": "Delete a note from a contact by its unique identifier.", "operationId": "deleteContactNote", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact the note belongs to.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "noteId", "required": true, "schema": { "description": "The unique identifier of the note to delete.", "examples": [ "6a145ff26212a192852c856f" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856f" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Contact Notes" ], "summary": "Update a contact note", "description": "Update a contact note's text.", "operationId": "updateContactNote", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact the note belongs to.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "noteId", "required": true, "schema": { "description": "The unique identifier of the note to update.", "examples": [ "6a145ff26212a192852c856f" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856f" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string", "description": "The updated body of the note.", "examples": [ "Please follow up with the customer." ], "minLength": 1, "maxLength": 2000, "example": "Please follow up with the customer." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "text", "media", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the note.", "examples": [ "6a145ff26212a192852c856f" ], "example": "6a145ff26212a192852c856f", "type": "string", "pattern": "^(.*)$" }, "text": { "type": "string", "description": "The body of the note.", "examples": [ "Please follow up with the customer." ], "example": "Please follow up with the customer." }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" ], "example": "https://example.com/i/f1726c08-8380-41d4-a583-dea176b2e695.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The file name of the attached media.", "examples": [ "an_image.png" ], "example": "an_image.png" }, { "type": "null" } ] } } }, "description": "Attachments on the note." }, "createdAt": { "description": "The timestamp of the note creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the note update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "actorId": { "description": "The actor ID that authored the note.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}/properties": { "get": { "tags": [ "Contact Properties" ], "summary": "List contact properties", "description": "Get a paginated list of properties for a contact.", "operationId": "listContactProperties", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 50, "default": 10, "description": "Page size" }, { "type": "null" } ] } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, { "type": "null" } ] } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "type": "string", "description": "Filter properties by type.", "examples": [ "phone-number", "email" ] }, { "type": "null" } ] } }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "example": "690cba5d99c5f41e1fa7aca3", "type": "string", "pattern": "^(.*)$" }, "type": { "type": "string", "description": "The type of the contact property.", "examples": [ "phone-number", "email", "string", "date", "boolean", "number" ], "example": "phone-number" }, "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } }, { "type": "array", "items": {}, "description": "An array of values of any type, for example numbers or objects.", "examples": [ [ 1, 2, 3 ] ], "example": [ 1, 2, 3 ] } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact property creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact property update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "post": { "tags": [ "Contact Properties" ], "summary": "Create a contact property", "description": "Add a new property to a contact.", "operationId": "createContactProperty", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "description": "The type of the contact property.", "examples": [ "phone-number", "email", "string", "date", "boolean", "number" ], "example": "phone-number" }, "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "type", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "example": "690cba5d99c5f41e1fa7aca3", "type": "string", "pattern": "^(.*)$" }, "type": { "type": "string", "description": "The type of the contact property.", "examples": [ "phone-number", "email", "string", "date", "boolean", "number" ], "example": "phone-number" }, "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } }, { "type": "array", "items": {}, "description": "An array of values of any type, for example numbers or objects.", "examples": [ [ 1, 2, 3 ] ], "example": [ 1, 2, 3 ] } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact property creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact property update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}/properties/{propertyId}": { "get": { "tags": [ "Contact Properties" ], "summary": "Get a contact property by ID", "description": "Retrieve a single property for a contact using the property's unique identifier.", "operationId": "getContactProperty", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "propertyId", "required": true, "schema": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "type": "string", "pattern": "^(.*)$" }, "example": "690cba5d99c5f41e1fa7aca3" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "type", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "example": "690cba5d99c5f41e1fa7aca3", "type": "string", "pattern": "^(.*)$" }, "type": { "type": "string", "description": "The type of the contact property.", "examples": [ "phone-number", "email", "string", "date", "boolean", "number" ], "example": "phone-number" }, "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } }, { "type": "array", "items": {}, "description": "An array of values of any type, for example numbers or objects.", "examples": [ [ 1, 2, 3 ] ], "example": [ 1, 2, 3 ] } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact property creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact property update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Contact Properties" ], "summary": "Update a contact property", "description": "Update a contact property's name or value.", "operationId": "updateContactProperty", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "propertyId", "required": true, "schema": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "type": "string", "pattern": "^(.*)$" }, "example": "690cba5d99c5f41e1fa7aca3" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" }, { "type": "null" } ] } }, "minProperties": 1 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "type", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "example": "690cba5d99c5f41e1fa7aca3", "type": "string", "pattern": "^(.*)$" }, "type": { "type": "string", "description": "The type of the contact property.", "examples": [ "phone-number", "email", "string", "date", "boolean", "number" ], "example": "phone-number" }, "name": { "anyOf": [ { "type": "string", "description": "The label for the contact property.", "examples": [ "Mobile" ], "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A string value.", "examples": [ "John Doe" ], "example": "John Doe" }, { "type": "boolean", "description": "A boolean value.", "examples": [ true ], "example": true }, { "type": "number", "description": "A number value.", "examples": [ 123 ], "example": 123 }, { "type": "array", "items": { "type": "string", "description": "An array of string values.", "examples": [ "John Doe", "Jane Doe" ], "example": "John Doe" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string", "description": "An array of arrays of string values.", "examples": [ [ "John Doe", "Jane Doe" ] ], "example": [ "John Doe", "Jane Doe" ] } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } }, { "type": "array", "items": {}, "description": "An array of values of any type, for example numbers or objects.", "examples": [ [ 1, 2, 3 ] ], "example": [ 1, 2, 3 ] } ], "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact property creation.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp of the contact property update.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Contact Properties" ], "summary": "Delete a contact property", "description": "Delete a property from a contact by its unique identifier.", "operationId": "deleteContactProperty", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "path", "name": "propertyId", "required": true, "schema": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "type": "string", "pattern": "^(.*)$" }, "example": "690cba5d99c5f41e1fa7aca3" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/contacts/{contactId}/shares": { "get": { "tags": [ "Contact Shares" ], "summary": "List contact shares", "description": "Get a paginated list of shares for a contact.", "operationId": "listContactShares", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact whose shares are being listed.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "contactId", "sharedWith", "createdAt" ], "properties": { "contactId": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "sharedWith": { "anyOf": [ { "type": "string", "pattern": "^OR(.*)$" }, { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^GR(.*)$" } ], "description": "The ID of the user, group, or organization the contact is shared with. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ "US123abc", "GR123abc", "OR8UgLbDLE" ], "example": "US123abc" }, "createdAt": { "description": "The timestamp the share was created.", "examples": [ "2021-01-01T00:00:00Z" ], "example": "2021-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Contact Shares" ], "summary": "Update contact shares", "description": "Add or remove the users, groups, or organization a contact is shared with. Only the shares you name change; the contact's other shares stay as they are.", "operationId": "updateContactShares", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact whose shares are being updated.", "examples": [ "6a145ff26212a192852c856e" ], "type": "string", "pattern": "^(.*)$" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "add": { "type": "array", "items": { "type": "string", "pattern": "^(US|GR|OR)(.*)$", "description": "A user, group, or organization ID. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ "US123abc", "GR123abc", "OR8UgLbDLE" ], "example": "US123abc" }, "maxItems": 100, "description": "The IDs of the users, groups, or organization to share the contact with, in addition to its current shares. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`. Each must belong to your organization. Sharing with your organization shares the contact with everyone in it.", "examples": [ [ "US123abc", "GR123abc" ] ], "example": [ "US123abc", "GR123abc" ] }, "remove": { "type": "array", "items": { "type": "string", "pattern": "^(US|GR|OR)(.*)$", "description": "A user, group, or organization ID. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ "US123abc", "GR123abc", "OR8UgLbDLE" ], "example": "US123abc" }, "maxItems": 100, "description": "The IDs of the users, groups, or organization to stop sharing the contact with. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`. IDs the contact isn't shared with are ignored. The contact's owner (the `actorId` returned by the list and get contact endpoints) cannot be removed: naming them here leaves them shared, and they are not included in `removed`.", "examples": [ [ "US456def" ] ], "example": [ "US456def" ] } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "contactId", "added", "removed" ], "properties": { "contactId": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "example": "6a145ff26212a192852c856e", "type": "string", "pattern": "^(.*)$" }, "added": { "type": "array", "items": { "type": "string", "pattern": "^(US|GR|OR)(.*)$", "description": "A user, group, or organization ID. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ "US123abc", "GR123abc", "OR8UgLbDLE" ], "example": "US123abc" }, "description": "The IDs the contact is now shared with that it wasn't before. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ [ "US123abc", "GR123abc" ] ], "example": [ "US123abc", "GR123abc" ] }, "removed": { "type": "array", "items": { "type": "string", "pattern": "^(US|GR|OR)(.*)$", "description": "A user, group, or organization ID. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ "US123abc", "GR123abc", "OR8UgLbDLE" ], "example": "US123abc" }, "description": "The IDs the contact was shared with and no longer is. User IDs start with `US`, group IDs start with `GR`, and organization IDs start with `OR`.", "examples": [ [ "US456def" ] ], "example": [ "US456def" ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/conversations": { "get": { "tags": [ "Conversations" ], "summary": "List conversations", "description": "Get a paginated list of the organization's conversations, most recently created first. With an OAuth token, only conversations on the phone numbers the user is a member of are returned.", "operationId": "listConversationsHeaderVersioned", "parameters": [ { "in": "query", "name": "phoneNumberId", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" }, "description": "Match conversations on any of these Quo phone number IDs (max 100).", "examples": [ "PN123abc,PN456def" ], "maxItems": 100 } }, "additionalProperties": false } ], "description": "Only return conversations on this Quo phone number ID, such as `phoneNumberId=PN123abc`. To match any of several, use `phoneNumberId[in]=PN123abc,PN456def` (max 100). Matches the Quo phone number only, not participant numbers.", "examples": [ "PN123abc" ] }, "style": "deepObject", "explode": true, "example": "PN123abc" }, { "in": "query", "name": "createdAt", "required": false, "schema": { "type": "object", "properties": { "gte": { "type": "string", "format": "date-time" }, "lte": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Bound the results by creation time (inclusive), in ISO 8601 format: `createdAt[gte]=2022-01-01T00:00:00Z&createdAt[lte]=2022-02-01T00:00:00Z`." }, "style": "deepObject", "explode": true }, { "in": "query", "name": "updatedAt", "required": false, "schema": { "type": "object", "properties": { "gte": { "type": "string", "format": "date-time" }, "lte": { "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Bound the results by last-updated time (inclusive), in ISO 8601 format: `updatedAt[gte]=2022-01-01T00:00:00Z&updatedAt[lte]=2022-02-01T00:00:00Z`." }, "style": "deepObject", "explode": true }, { "in": "query", "name": "sort", "required": false, "schema": { "type": "string", "description": "A single field:direction pair. Allowed fields: createdAt, updatedAt. Direction must be asc or desc.", "examples": [ "createdAt:desc" ] }, "example": "createdAt:desc" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "lastActivityAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "type": "string", "description": "A phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`).", "examples": [ "+15555555555", "12345", "Anonymous" ], "pattern": "^(?:\\+[1-9]\\d{1,14}|\\d{5,6}|[aA](?:nonymous|NONYMOUS)|[bB](?:locked|LOCKED)|[rR](?:estricted|ESTRICTED))$", "example": "+15555555555" }, "description": "An array of phone numbers involved in the call, excluding your Quo number. Each number is either a phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`)." }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "snoozedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/conversations/{conversationId}/mark-as-read": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as read", "description": "Mark a conversation as read, clearing its unread indicator without sending a message. Returns the updated conversation.", "operationId": "markConversationAsRead", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as read.", "examples": [ "CN123abc" ], "type": "string", "pattern": "^CN(.*)$" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "lastActivityAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "type": "string", "description": "A phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`).", "examples": [ "+15555555555", "12345", "Anonymous" ], "pattern": "^(?:\\+[1-9]\\d{1,14}|\\d{5,6}|[aA](?:nonymous|NONYMOUS)|[bB](?:locked|LOCKED)|[rR](?:estricted|ESTRICTED))$", "example": "+15555555555" }, "description": "An array of phone numbers involved in the call, excluding your Quo number. Each number is either a phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`)." }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "snoozedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/conversations/{conversationId}/mark-as-done": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as done", "description": "Mark a conversation as done, removing it from the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsDone", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as done.", "examples": [ "CN123abc" ], "type": "string", "pattern": "^CN(.*)$" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "lastActivityAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "type": "string", "description": "A phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`).", "examples": [ "+15555555555", "12345", "Anonymous" ], "pattern": "^(?:\\+[1-9]\\d{1,14}|\\d{5,6}|[aA](?:nonymous|NONYMOUS)|[bB](?:locked|LOCKED)|[rR](?:estricted|ESTRICTED))$", "example": "+15555555555" }, "description": "An array of phone numbers involved in the call, excluding your Quo number. Each number is either a phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`)." }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "snoozedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/conversations/{conversationId}/mark-as-open": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as open", "description": "Mark a conversation as open, returning it to the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsOpen", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as open.", "examples": [ "CN123abc" ], "type": "string", "pattern": "^CN(.*)$" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "createdAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "lastActivityAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "name": { "anyOf": [ { "type": "string", "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "type": "string", "description": "A phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`).", "examples": [ "+15555555555", "12345", "Anonymous" ], "pattern": "^(?:\\+[1-9]\\d{1,14}|\\d{5,6}|[aA](?:nonymous|NONYMOUS)|[bB](?:locked|LOCKED)|[rR](?:estricted|ESTRICTED))$", "example": "+15555555555" }, "description": "An array of phone numbers involved in the call, excluding your Quo number. Each number is either a phone number in E.164 format, a short code (5-6 digits, no country code), or a non-phone-number caller ID (`Anonymous`, `Blocked`, or `Restricted`)." }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "snoozedUntil": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/messages": { "get": { "tags": [ "Messages" ], "summary": "List messages", "description": "Get a paginated list of the organization's messages across all conversations, most recently created first. Supports filtering by from (the sender, equality), to (the exact recipient set, via a bare value or a comma-separated `to[all]` list), status, direction, phoneNumberId, userId, and a createdAt date range. With an OAuth token, only messages on the phone numbers the user is a member of are returned.", "operationId": "listMessages", "parameters": [ { "in": "query", "name": "from", "required": false, "schema": { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), or a non-phone-number caller ID (Anonymous, Restricted, or Blocked).", "examples": [ "+15555555555", "12345", "Anonymous" ] }, { "type": "null" } ] } }, { "in": "query", "name": "to", "required": false, "schema": { "anyOf": [ { "anyOf": [ { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), or a non-phone-number caller ID (Anonymous, Restricted, or Blocked).", "examples": [ "+15555555555", "12345", "Anonymous" ] }, { "type": "object", "required": [ "all" ], "properties": { "all": { "type": "string", "description": "Comma-separated list of values; matches messages whose recipients are exactly this set (order-independent), not a subset or superset of it.", "examples": [ "+15555555555,+15555555556" ] } } } ] }, { "type": "null" } ] }, "style": "deepObject", "explode": true }, { "in": "query", "name": "status", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received", "failed" ], "description": "The status of the message.", "examples": [ "sent" ] }, { "type": "null" } ] } }, { "in": "query", "name": "direction", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the message relative to the Quo number.", "examples": [ "incoming" ] }, { "type": "null" } ] } }, { "in": "query", "name": "phoneNumberId", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] } }, { "in": "query", "name": "userId", "required": false, "schema": { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] } }, { "in": "query", "name": "createdAt", "required": false, "schema": { "anyOf": [ { "type": "object", "properties": { "gt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "lt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] } } }, { "type": "null" } ] }, "style": "deepObject", "explode": true }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "to", "from", "text", "conversationId", "direction", "status", "createdAt", "updatedAt", "media" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "description": "Recipients of the message. Includes your Quo number for incoming messages." }, "from": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "text": { "type": "string", "description": "The content of the message.", "examples": [ "Hello, world!" ], "example": "Hello, world!" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo phone number that the message was sent from.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the message relative to the Quo number.", "examples": [ "incoming" ], "example": "incoming" }, "userId": { "anyOf": [ { "description": "The unique identifier of the user or system actor (e.g. Sona) who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received", "failed" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp when the message status was last updated, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/image.png" ], "example": "https://example.com/image.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] } } }, "description": "Media attached to the message." } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } }, "post": { "tags": [ "Messages" ], "summary": "Send a message", "description": "Send a text message from your Quo number to one or more recipients.", "operationId": "sendMessage", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "content", "from", "to" ], "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 1600, "description": "The content of your message.", "examples": [ "Good morning, your service appointment has been booked." ], "example": "Good morning, your service appointment has been booked." }, "from": { "description": "The ID of the Quo phone number to send from. The sender must be a user on this number.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "to": { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" } ], "description": "A recipient phone number in E.164 format, or a short code (3-8 digits).", "examples": [ "+15555555555", "12345" ], "example": "+15555555555" }, "minItems": 1, "maxItems": 10, "description": "The recipients of the message, each a phone number in E.164 format or a short code (3-8 digits). More than one sends a group message. At most 10.", "examples": [ [ "+15555555555" ], [ "+15555555555", "+15555555556" ] ], "example": [ "+15555555555" ] }, "senderUserId": { "anyOf": [ { "description": "The unique identifier of the Quo user sending the message. If not provided, the message is attributed to the owner of the phone number it is sent from. The sending user must be a member of the phone number the message is sent from.", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] }, "inboxStatus": { "anyOf": [ { "description": "Used to set the status of the related Quo inbox conversation. The default behavior without setting this parameter will be for the message sent to show up as an open conversation in the user's inbox. Setting the parameter to 'done' would move the conversation to the Done inbox view.", "examples": [ "done" ], "example": "done", "type": "string", "const": "done" }, { "type": "null" } ] } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "to", "from", "text", "conversationId", "direction", "status", "createdAt", "updatedAt", "media" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "description": "Recipients of the message. Includes your Quo number for incoming messages." }, "from": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "text": { "type": "string", "description": "The content of the message.", "examples": [ "Hello, world!" ], "example": "Hello, world!" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo phone number that the message was sent from.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the message relative to the Quo number.", "examples": [ "incoming" ], "example": "incoming" }, "userId": { "anyOf": [ { "description": "The unique identifier of the user or system actor (e.g. Sona) who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received", "failed" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp when the message status was last updated, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/image.png" ], "example": "https://example.com/image.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] } } }, "description": "Media attached to the message." } } } } } } } }, "400": { "description": "Bad Request | Invalid `to` Phone Number | Unreachable `to` Phone Number | User Opted Out | Not TFN Registered | A2P Registration Not Approved", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/InvalidToPhoneNumberError" }, { "$ref": "#/components/schemas/UnreachableToPhoneNumberError" }, { "$ref": "#/components/schemas/UserOptedOutError" }, { "$ref": "#/components/schemas/NotTFNRegisteredError" }, { "$ref": "#/components/schemas/A2PRegistrationNotApprovedError" } ] }, "examples": { "BadRequestError": { "summary": "Bad Request", "value": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } }, "InvalidToPhoneNumberError": { "summary": "Invalid `to` Phone Number", "value": { "message": "At least one recipient in `to` is invalid", "docs": "https://quo.com/docs", "title": "Invalid `to` Phone Number", "trace": "6897907457496870895" } }, "UnreachableToPhoneNumberError": { "summary": "Unreachable `to` Phone Number", "value": { "message": "At least one recipient in `to` is not currently reachable via SMS", "docs": "https://quo.com/docs", "title": "Unreachable `to` Phone Number", "trace": "6897907457496870895" } }, "UserOptedOutError": { "summary": "User Opted Out", "value": { "message": "User has opted out of receiving messages", "docs": "https://quo.com/docs", "title": "User Opted Out", "trace": "6897907457496870895" } }, "NotTFNRegisteredError": { "summary": "Not TFN Registered", "value": { "message": "The toll-free phone number is not registered for TFN messaging", "docs": "https://quo.com/docs", "title": "Not TFN Registered", "trace": "6897907457496870895" } }, "A2PRegistrationNotApprovedError": { "summary": "A2P Registration Not Approved", "value": { "message": "The organization is not approved for A2P", "docs": "https://quo.com/docs", "title": "A2P Registration Not Approved", "trace": "6897907457496870895" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Not Enough Credits | Subscription Expired", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NotEnoughCreditsError" }, { "$ref": "#/components/schemas/SubscriptionExpiredError" } ] }, "examples": { "NotEnoughCreditsError": { "summary": "Not Enough Credits", "value": { "message": "The organization does not have enough prepaid credits to send the message", "docs": "https://quo.com/docs", "title": "Not Enough Credits", "trace": "6897907457496870895" } }, "SubscriptionExpiredError": { "summary": "Subscription Expired", "value": { "message": "Your subscription has expired", "docs": "https://quo.com/docs", "title": "Subscription Expired", "trace": "6897907457496870895" } } } } } }, "403": { "description": "Forbidden | Not Phone Number User | A2P 10DLC Daily Message Cap Reached | International Messaging Not Allowed", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError" }, { "$ref": "#/components/schemas/A2P10DLCDailyMessageCapReachedError" }, { "$ref": "#/components/schemas/InternationalMessagingNotAllowedError" } ] }, "examples": { "ForbiddenError": { "summary": "Forbidden", "value": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } }, "NotPhoneNumberUserError": { "summary": "Not Phone Number User", "value": { "message": "Sender not authorized to send messages from this phone number.", "docs": "https://quo.com/docs", "title": "Not Phone Number User", "trace": "6897907457496870895" } }, "A2P10DLCDailyMessageCapReachedError": { "summary": "A2P 10DLC Daily Message Cap Reached", "value": { "message": "A2P 10DLC Daily limit reached. For help increasing this limit, visit https://support.quo.com/help/submit-a-request", "docs": "https://quo.com/docs", "title": "A2P 10DLC Daily Message Cap Reached", "trace": "6897907457496870895" } }, "InternationalMessagingNotAllowedError": { "summary": "International Messaging Not Allowed", "value": { "message": "International messaging is not enabled for the sender phone number", "docs": "https://quo.com/docs", "title": "International Messaging Not Allowed", "trace": "6897907457496870895" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "429": { "description": "Too Many Requests", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Too Many Requests" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The organization has reached its limit for starting new conversations. Try again later.", "docs": "https://quo.com/docs", "title": "Too Many Requests", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/messages/{messageId}": { "get": { "tags": [ "Messages" ], "summary": "Get a message by ID", "description": "Get a single message by its unique identifier, including any attached media.", "operationId": "getMessageById", "parameters": [ { "in": "path", "name": "messageId", "required": true, "schema": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "to", "from", "text", "conversationId", "direction", "status", "createdAt", "updatedAt", "media" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "type": "array", "items": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "description": "Recipients of the message. Includes your Quo number for incoming messages." }, "from": { "anyOf": [ { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, { "type": "string", "description": "Short code phone number (3-8 digits, no country code)", "pattern": "^[0-9]{3,8}$" }, { "type": "string", "pattern": "^([aA](nonymous|NONYMOUS)|[bB](locked|LOCKED)|[rR](estricted|ESTRICTED))$" }, { "type": "string" } ], "description": "A phone number in E.164 format, a short code (3-8 digits), a non-phone-number caller ID (Anonymous, Restricted, or Blocked), or another value as delivered by the carrier, such as an alphanumeric sender ID.", "examples": [ "+15555555555", "12345", "Anonymous" ], "example": "+15555555555" }, "text": { "type": "string", "description": "The content of the message.", "examples": [ "Hello, world!" ], "example": "Hello, world!" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo phone number that the message was sent from.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, "direction": { "type": "string", "enum": [ "incoming", "outgoing" ], "description": "The direction of the message relative to the Quo number.", "examples": [ "incoming" ], "example": "incoming" }, "userId": { "anyOf": [ { "description": "The unique identifier of the user or system actor (e.g. Sona) who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received", "failed" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The timestamp when the message status was last updated, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "media": { "type": "array", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "description": "The URL of the attached media.", "examples": [ "https://example.com/image.png" ], "example": "https://example.com/image.png" }, "type": { "anyOf": [ { "type": "string", "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" }, { "type": "null" } ] } } }, "description": "Media attached to the message." } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/messages/{messageId}/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry a failed message", "description": "Attempt to re-deliver a message that previously failed to send. Only messages with a `failed` status can be retried. Messages that have permanently failed (a `failed` status with an error code) and messages with an `undelivered` status cannot be retried.", "operationId": "retryMessage", "parameters": [ { "in": "path", "name": "messageId", "required": true, "schema": { "description": "The unique identifier of the message to retry", "examples": [ "AC123abc" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Text Allowance Used Up. The workspace is on an agent plan and has no texts left. The message says which allowance is used up and how to get more.", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Text Allowance Used Up" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unprocessable Entity" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/organization": { "get": { "tags": [ "Organization" ], "summary": "Get the organization", "description": "Retrieve information about the Quo workspace.", "operationId": "getOrganization", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "name", "subscriptionStatus", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the organization.", "examples": [ "ORabc123" ], "example": "ORabc123", "type": "string", "pattern": "^OR(.*)$" }, "name": { "anyOf": [ { "type": "string", "description": "The name of the organization.", "examples": [ "Acme Inc" ], "example": "Acme Inc" }, { "type": "null" } ] }, "subscriptionStatus": { "type": "string", "enum": [ "active", "expired" ], "description": "The status of the organization's subscription. `expired` covers organizations whose billing period has lapsed as well as those without a subscription.", "examples": [ "active", "expired" ], "example": "active" }, "createdAt": { "description": "Timestamp of organization creation in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of the last organization update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Organization with ID OR1234567 not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unknown" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } } ] }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } } } } } } }, "/phone-numbers": { "get": { "tags": [ "Phone Numbers" ], "summary": "List phone numbers", "description": "Retrieve a paginated list of the phone numbers in your Quo workspace. Assigned users and usage restrictions are opt-in through the `include` parameter.", "operationId": "listPhoneNumbers", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "query", "name": "phoneNumber", "required": false, "schema": { "type": "string", "description": "Filter results to the phone number matching this E.164 value.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$" }, "example": "+15555555555" }, { "in": "query", "name": "include", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "restrictions" ] }, "description": "Comma-separated list of optional payload sections to include. `restrictions` adds the number’s calling and messaging restrictions. Omitted sections are left out of the response entirely. The members assigned to a number are their own endpoint, `GET /phone-numbers/{phoneNumberId}/users`.", "examples": [ "restrictions" ], "maxItems": 1, "uniqueItems": true }, "example": "restrictions" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "groupId", "name", "phoneNumber", "formattedNumber", "forward", "portRequestId", "portingStatus", "symbol", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the Quo phone number.", "examples": [ "PNlja6rrtI" ], "example": "PNlja6rrtI", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" }, "name": { "type": "string", "description": "The display name of the phone number.", "examples": [ "My phone number" ], "example": "My phone number" }, "phoneNumber": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of the phone number.", "examples": [ "(555) 555-5555" ], "example": "(555) 555-5555" }, { "type": "null" } ] }, "forward": { "anyOf": [ { "type": "string", "description": "Forwarding number for incoming calls, null if no forwarding number is configured.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "type": "null" } ] }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "portingStatus": { "anyOf": [ { "type": "string", "description": "Current status of the porting process, if applicable.", "examples": [ "completed" ], "example": "completed" }, { "type": "null" } ] }, "symbol": { "anyOf": [ { "type": "string", "description": "Custom symbol or emoji associated with the phone number.", "examples": [ "🏡" ], "example": "🏡" }, { "type": "null" } ] }, "createdAt": { "description": "Timestamp of when the phone number was added to the workspace, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of the last update to the phone number’s details, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "restrictions": { "type": "object", "required": [ "calling", "messaging" ], "properties": { "calling": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } }, "messaging": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } } } } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/phone-numbers/{phoneNumberId}": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get a phone number by ID", "description": "Retrieve a single phone number in your Quo workspace by its unique identifier. Assigned users and usage restrictions are opt-in through the `include` parameter.", "operationId": "getPhoneNumberById", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the phone number being referenced (used).", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" }, { "in": "query", "name": "include", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "restrictions", "businessHours" ] }, "description": "Comma-separated list of optional payload sections to include. `restrictions` adds the number’s calling and messaging restrictions. `businessHours` adds the number’s business hours: whether they are enforced, their timezone, and the window for each day; with nothing stored, `enabled` is `false`, `timezone` is `America/Los_Angeles` and the schedule is `null`. `businessHours` is only available on this endpoint, not on the list. Omitted sections are left out of the response entirely. The members assigned to a number are their own endpoint, `GET /phone-numbers/{phoneNumberId}/users`.", "maxItems": 2, "uniqueItems": true, "examples": [ "restrictions", "businessHours", "restrictions,businessHours" ] }, "example": "restrictions" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "groupId", "name", "phoneNumber", "formattedNumber", "forward", "portRequestId", "portingStatus", "symbol", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the Quo phone number.", "examples": [ "PNlja6rrtI" ], "example": "PNlja6rrtI", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" }, "name": { "type": "string", "description": "The display name of the phone number.", "examples": [ "My phone number" ], "example": "My phone number" }, "phoneNumber": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of the phone number.", "examples": [ "(555) 555-5555" ], "example": "(555) 555-5555" }, { "type": "null" } ] }, "forward": { "anyOf": [ { "type": "string", "description": "Forwarding number for incoming calls, null if no forwarding number is configured.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "type": "null" } ] }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "portingStatus": { "anyOf": [ { "type": "string", "description": "Current status of the porting process, if applicable.", "examples": [ "completed" ], "example": "completed" }, { "type": "null" } ] }, "symbol": { "anyOf": [ { "type": "string", "description": "Custom symbol or emoji associated with the phone number.", "examples": [ "🏡" ], "example": "🏡" }, { "type": "null" } ] }, "createdAt": { "description": "Timestamp of when the phone number was added to the workspace, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of the last update to the phone number’s details, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "restrictions": { "type": "object", "required": [ "calling", "messaging" ], "properties": { "calling": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } }, "messaging": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } } } }, "businessHours": { "type": "object", "required": [ "enabled", "timezone", "schedule" ], "properties": { "enabled": { "type": "boolean", "description": "Specifies if business hours is enforced for this number. `false` when nothing is stored." }, "timezone": { "anyOf": [ { "type": "string", "description": "IANA timezone used to interpret `schedule`. `America/Los_Angeles` when none is stored, since that is the timezone account applies the schedule in.", "examples": [ "America/New_York" ], "example": "America/New_York" }, { "type": "string" } ], "description": "IANA timezone used to interpret `schedule`. `America/Los_Angeles` when none is stored, since that is the timezone account applies the schedule in.", "examples": [ "America/New_York" ], "example": "America/New_York" }, "schedule": { "anyOf": [ { "type": "object", "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "properties": { "monday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Phone Numbers" ], "summary": "Update a phone number", "description": "Update the name and business hours of a phone number. Only the fields in the request change; a field left out keeps its stored value, and the body must name at least one field. With a user token, only the number’s owners and admins can update it: a member assigned to it gets `403 Forbidden`, and a user not assigned to it gets `404 Not Found`. The response is the updated phone number with its `businessHours`, as `GET /phone-numbers/{phoneNumberId}?include=businessHours` returns it.", "operationId": "updatePhoneNumber", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the phone number being referenced (used).", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The display name of the phone number. Left out, the stored name is kept.", "minLength": 1, "maxLength": 500, "examples": [ "My phone number" ], "example": "My phone number" }, "businessHours": { "type": "object", "properties": { "enabled": { "type": "boolean", "description": "Specifies if business hours is enforced for this number. Left out, the stored value is kept. Turning it on has no effect until the number has a `schedule`." }, "timezone": { "type": "string", "description": "IANA timezone used to interpret `schedule`. Left out, the stored timezone is kept, or `America/Los_Angeles` when none is stored. Required when the stored timezone is not a valid IANA timezone and the resulting schedule has any window.", "examples": [ "America/New_York" ], "example": "America/New_York" }, "schedule": { "anyOf": [ { "type": "object", "properties": { "monday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] } }, "minProperties": 1 }, { "type": "null" } ] } }, "minProperties": 1 } }, "minProperties": 1 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "groupId", "name", "phoneNumber", "formattedNumber", "forward", "portRequestId", "portingStatus", "symbol", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the Quo phone number.", "examples": [ "PNlja6rrtI" ], "example": "PNlja6rrtI", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" }, "name": { "type": "string", "description": "The display name of the phone number.", "examples": [ "My phone number" ], "example": "My phone number" }, "phoneNumber": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of the phone number.", "examples": [ "(555) 555-5555" ], "example": "(555) 555-5555" }, { "type": "null" } ] }, "forward": { "anyOf": [ { "type": "string", "description": "Forwarding number for incoming calls, null if no forwarding number is configured.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "type": "null" } ] }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "portingStatus": { "anyOf": [ { "type": "string", "description": "Current status of the porting process, if applicable.", "examples": [ "completed" ], "example": "completed" }, { "type": "null" } ] }, "symbol": { "anyOf": [ { "type": "string", "description": "Custom symbol or emoji associated with the phone number.", "examples": [ "🏡" ], "example": "🏡" }, { "type": "null" } ] }, "createdAt": { "description": "Timestamp of when the phone number was added to the workspace, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of the last update to the phone number’s details, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "restrictions": { "type": "object", "required": [ "calling", "messaging" ], "properties": { "calling": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } }, "messaging": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } } } }, "businessHours": { "type": "object", "required": [ "enabled", "timezone", "schedule" ], "properties": { "enabled": { "type": "boolean", "description": "Specifies if business hours is enforced for this number. `false` when nothing is stored." }, "timezone": { "anyOf": [ { "type": "string", "description": "IANA timezone used to interpret `schedule`. `America/Los_Angeles` when none is stored, since that is the timezone account applies the schedule in.", "examples": [ "America/New_York" ], "example": "America/New_York" }, { "type": "string" } ], "description": "IANA timezone used to interpret `schedule`. `America/Los_Angeles` when none is stored, since that is the timezone account applies the schedule in.", "examples": [ "America/New_York" ], "example": "America/New_York" }, "schedule": { "anyOf": [ { "type": "object", "required": [ "monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday" ], "properties": { "monday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "tuesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "wednesday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "thursday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "friday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "saturday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] }, "sunday": { "anyOf": [ { "type": "object", "required": [ "start", "end" ], "properties": { "start": { "type": "string", "description": "Start of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" }, "end": { "type": "string", "description": "End of the available window, in 24-hour `HHMM` local time.", "pattern": "^([01][0-9]|2[0-3])[0-5][0-9]$", "examples": [ "0900", "1600" ], "example": "0900" } } }, { "type": "null" } ] } } }, { "type": "null" } ] } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/phone-numbers/available": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get available phone numbers", "description": "Get a list of available phone numbers", "operationId": "getAvailablePhoneNumbersBase", "parameters": [ { "in": "query", "name": "areaCode", "required": false, "schema": { "type": "string", "description": "Filter results to phone numbers in this area code.", "examples": [ "415" ] }, "example": "415" }, { "in": "query", "name": "contains", "required": false, "schema": { "type": "string", "description": "Filter results to phone numbers containing this substring.", "examples": [ "555" ] }, "example": "555" }, { "in": "query", "name": "countryCode", "required": false, "schema": { "type": "string", "description": "Filter results to phone numbers in this country.", "examples": [ "US" ] }, "example": "US" }, { "in": "query", "name": "inLocality", "required": false, "schema": { "type": "string", "description": "Filter results to phone numbers in this locality (city).", "examples": [ "San Francisco" ] }, "example": "San Francisco" }, { "in": "query", "name": "inRegion", "required": false, "schema": { "type": "string", "description": "Filter results to phone numbers in this region (state or province).", "examples": [ "CA" ] }, "example": "CA" }, { "in": "query", "name": "tollFree", "required": false, "schema": { "type": "boolean", "description": "When true, filter results to toll-free numbers only.", "examples": [ false ] }, "example": false }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "minimum": 1, "maximum": 100, "default": 10, "description": "Maximum number of phone numbers to return.", "examples": [ 10 ] }, "example": 10 }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "phoneNumbers" ], "properties": { "phoneNumbers": { "type": "array", "items": { "type": "string" } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/phone-numbers/{phoneNumberId}/settings": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get settings for phone number", "description": "Get settings for phone number", "operationId": "getPhoneNumberSettings", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the phone number being referenced (used).", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "bearerAuth": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "phoneNumberId", "autoRecord", "callDisclosure" ], "properties": { "phoneNumberId": { "description": "The unique identifier of the phone number these settings belong to.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "autoRecord": { "type": "boolean", "description": "Whether calls on this phone number are automatically recorded." }, "callDisclosure": { "type": "object", "required": [ "inbound", "outbound" ], "properties": { "inbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" }, "outbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Phone Numbers" ], "summary": "Update phone number settings", "description": "Update the settings of a phone number. Only the settings in the request change, and the body must include at least one of them.", "operationId": "updatePhoneNumberSettings", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the phone number being referenced (used).", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "autoRecord": { "type": "boolean", "description": "Whether calls on this phone number are automatically recorded.", "examples": [ true, false ], "example": true }, "callDisclosure": { "type": "object", "properties": { "inbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" }, "outbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" } }, "minProperties": 1 } }, "minProperties": 1 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "phoneNumberId", "autoRecord", "callDisclosure" ], "properties": { "phoneNumberId": { "description": "The unique identifier of the phone number these settings belong to.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "autoRecord": { "type": "boolean", "description": "Whether calls on this phone number are automatically recorded." }, "callDisclosure": { "type": "object", "required": [ "inbound", "outbound" ], "properties": { "inbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" }, "outbound": { "type": "string", "enum": [ "voice", "audioTone", "disabled" ], "description": "How callers are notified that the call may be recorded. `voice` plays a spoken announcement, `audioTone` plays a tone, `disabled` plays no notification.", "examples": [ "voice" ], "example": "voice" } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/phone-numbers/{phoneNumberId}/users": { "get": { "tags": [ "Phone Numbers" ], "summary": "List the members assigned to a phone number", "description": "Fetch a paginated list of the members assigned to a phone number, ordered by user id. The assignment itself carries no timestamp, so user id is the only stable order available.", "operationId": "listPhoneNumberUsers", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the phone number whose members are being listed.", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "role", "groupId" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "email": { "type": "string", "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "type": "string", "description": "The user's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The user's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "description": "The user's role in the organization.", "examples": [ "owner", "admin", "member" ], "example": "owner" }, "groupId": { "description": "The unique identifier of the group to which the user belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/include", "message": "Value must be one of: users, restrictions", "value": "settings", "schema": { "type": "array" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Phone number with ID PNlja6rrtI not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/tasks": { "get": { "tags": [ "Tasks" ], "summary": "List tasks", "description": "Get a list of tasks", "operationId": "tasks.list", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 50, "maximum": 100, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "taskId", "orgId", "createdBy", "createdAt", "status", "revision" ], "properties": { "taskId": { "description": "The unique identifier of a task", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67", "type": "string", "pattern": "^TK(.*)$" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo phone number linked to this task. `null` for an org-wide task that is not linked to a phone number.", "examples": [ "PN123bc" ], "example": "PN123bc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "anyOf": [ { "description": "The unique identifier of the conversation linked to this task. `null` when the task is not linked to a conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, { "type": "null" } ] }, "activityId": { "anyOf": [ { "description": "The unique identifier of the activity linked to this task. `null` when the task is not linked to an activity.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "phoneNumberGroupId": { "anyOf": [ { "type": "string", "description": "The unique identifier of the group to which the Quo number belongs. `null` for an org-wide task, which is visible to every member of the organization.", "examples": [ "1234" ], "example": "1234" }, { "type": "null" } ] }, "orgId": { "description": "The unique identifier of the organization linked to this task.", "examples": [ "OR123abc" ], "example": "OR123abc", "type": "string", "pattern": "^OR(.*)$" }, "title": { "anyOf": [ { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "assignedTo": { "anyOf": [ { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "SYU123abc", "US123abc" ], "example": "SYU123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "assignedBy": { "anyOf": [ { "description": "The unique identifier of the actor that assigned this task.", "examples": [ "SYU123abc", "US123abc" ], "example": "SYU123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "createdBy": { "type": "string", "description": "The unique identifier of the actor/user that created the task.", "examples": [ "US123abc" ], "example": "US123abc" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "anyOf": [ { "description": "When the task was last marked completed. `null` while the task is open.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "const": "completed" }, { "type": "string", "const": "open" }, { "type": "string", "const": "deleted" } ], "description": "The status of a task", "examples": [ "open", "completed" ], "example": "open" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 7 ], "example": 2 } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Create task", "description": "Create a new task, optionally linked to either a conversation or a phone number, but not both. Omit both `conversationId` and `phoneNumberId` to create an org-wide task visible to every member of the organization.", "operationId": "tasks.create", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "title", "description", "conversationId" ], "properties": { "title": { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, "description": { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "conversationId": { "description": "The unique identifier of the conversation to link this task to.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" } }, "additionalProperties": false, "title": "Linked to a conversation" }, { "type": "object", "required": [ "title", "description", "phoneNumberId" ], "properties": { "title": { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, "description": { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number to link this task to. With an access token, the user must be a member of the phone number; with an API key, the phone number must belong to the organization.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" } }, "additionalProperties": false, "title": "Linked to a phone number" }, { "type": "object", "required": [ "title", "description" ], "properties": { "title": { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, "description": { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } }, "additionalProperties": false, "title": "Org-wide task" } ], "description": "The task to create. Provide at most one of `conversationId` or `phoneNumberId` to link the task to that resource. Omit both to create an org-wide task, visible to every member of the organization." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Open Tasks Limit Reached" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Open tasks limit reached", "docs": "https://quo.com/docs", "title": "Open Tasks Limit Reached", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Get a task by task ID", "description": "Get a task by task ID", "operationId": "tasks.get", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "orgId", "createdBy", "createdAt", "status", "revision" ], "properties": { "taskId": { "description": "The unique identifier of a task", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67", "type": "string", "pattern": "^TK(.*)$" }, "phoneNumberId": { "anyOf": [ { "description": "The unique identifier of the Quo phone number linked to this task. `null` for an org-wide task that is not linked to a phone number.", "examples": [ "PN123bc" ], "example": "PN123bc", "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "anyOf": [ { "description": "The unique identifier of the conversation linked to this task. `null` when the task is not linked to a conversation.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" }, { "type": "null" } ] }, "activityId": { "anyOf": [ { "description": "The unique identifier of the activity linked to this task. `null` when the task is not linked to an activity.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "phoneNumberGroupId": { "anyOf": [ { "type": "string", "description": "The unique identifier of the group to which the Quo number belongs. `null` for an org-wide task, which is visible to every member of the organization.", "examples": [ "1234" ], "example": "1234" }, { "type": "null" } ] }, "orgId": { "description": "The unique identifier of the organization linked to this task.", "examples": [ "OR123abc" ], "example": "OR123abc", "type": "string", "pattern": "^OR(.*)$" }, "title": { "anyOf": [ { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "assignedTo": { "anyOf": [ { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "SYU123abc", "US123abc" ], "example": "SYU123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "assignedBy": { "anyOf": [ { "description": "The unique identifier of the actor that assigned this task.", "examples": [ "SYU123abc", "US123abc" ], "example": "SYU123abc", "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "createdBy": { "type": "string", "description": "The unique identifier of the actor/user that created the task.", "examples": [ "US123abc" ], "example": "US123abc" }, "createdAt": { "type": "string", "format": "date-time" }, "completedAt": { "anyOf": [ { "description": "When the task was last marked completed. `null` while the task is open.", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "const": "completed" }, { "type": "string", "const": "open" }, { "type": "string", "const": "deleted" } ], "description": "The status of a task", "examples": [ "open", "completed" ], "example": "open" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 7 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "patch": { "tags": [ "Tasks" ], "summary": "Update task", "description": "Update a task title and/or description", "operationId": "tasks.update", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "title", "description" ], "properties": { "title": { "type": "string", "description": "The title of the task", "examples": [ "Example task title" ], "example": "Example task title" }, "description": { "type": "string", "description": "The description of the task", "examples": [ "This is a task description." ], "example": "This is a task description." } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete task", "description": "Delete a task by task ID", "operationId": "tasks.delete", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/tasks/{taskId}/status": { "patch": { "tags": [ "Tasks" ], "summary": "Update the status for a task", "description": "Update the status for a task", "operationId": "tasks.updateStatus", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "status" ], "properties": { "status": { "anyOf": [ { "type": "string", "const": "completed" }, { "type": "string", "const": "open" }, { "type": "string", "const": "deleted" } ], "description": "The status of a task", "examples": [ "open", "completed" ], "example": "open" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Open Tasks Limit Reached" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Open tasks limit reached", "docs": "https://quo.com/docs", "title": "Open Tasks Limit Reached", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/tasks/{taskId}/conversations": { "post": { "tags": [ "Tasks" ], "summary": "Link a task to a conversation", "description": "Link a task to the conversation", "operationId": "tasks.linkConversation", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "conversationId" ], "properties": { "conversationId": { "description": "The unique identifier of the conversation linked to this task.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Unlink a task from a conversation", "description": "Unlink a task from a conversation", "operationId": "tasks.unlinkConversation", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "conversationId" ], "properties": { "conversationId": { "description": "The unique identifier of the conversation linked to this task.", "examples": [ "CN123abc" ], "example": "CN123abc", "type": "string", "pattern": "^CN(.*)$" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/tasks/{taskId}/users": { "post": { "tags": [ "Tasks" ], "summary": "Assign a task to a user", "description": "Assign a task to the user", "operationId": "tasks.assignUser", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Unassign a task to a user", "description": "Unassign a task to the user", "operationId": "tasks.unassignUser", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "description": "The unique identifier of the actor assigned to this task.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/tasks/{taskId}/due-date": { "patch": { "tags": [ "Tasks" ], "summary": "Update the due date of a task", "description": "Update the due date of a task", "operationId": "tasks.updateDueDate", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "dueDate" ], "properties": { "dueDate": { "type": "string", "format": "date-time" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete the due date of a task", "description": "Delete the due date of a task", "operationId": "tasks.deleteDueDate", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "description": "The unique identifier of the task.", "examples": [ "TKb4164b7f9b3d40e79ea4af4f2298ed67" ], "type": "string", "pattern": "^TK(.*)$" }, "example": "TKb4164b7f9b3d40e79ea4af4f2298ed67" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "description": "The ID of the task", "examples": [ "TK123" ], "example": "TK123", "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "integer", "description": "The revision number of the task", "examples": [ 2, 5 ], "example": 2 } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "An unexpected error has occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "List users", "description": "Retrieve a paginated list of users in your Quo workspace.", "operationId": "listUsers", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "email": { "type": "string", "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "type": "string", "description": "The user's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The user's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "type": "string", "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "example": "https://example.com/picture.jpg" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "description": "The user's role in the organization.", "examples": [ "owner", "admin", "member" ], "example": "owner" }, "createdAt": { "description": "Timestamp of user creation in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "Get a user by ID", "description": "Retrieve detailed information about a specific user in your Quo workspace using the user's unique identifier.", "operationId": "getUserById", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "description": "The unique identifier of the user being retrieved.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "email": { "type": "string", "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "type": "string", "description": "The user's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The user's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "type": "string", "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "example": "https://example.com/picture.jpg" }, { "type": "null" } ] }, "role": { "type": "string", "enum": [ "owner", "admin", "member" ], "description": "The user's role in the organization.", "examples": [ "owner", "admin", "member" ], "example": "owner" }, "createdAt": { "description": "Timestamp of user creation in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User with ID US1234567890 not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/users/{userId}/phone-numbers": { "get": { "tags": [ "User Phone Numbers" ], "summary": "List a user's phone numbers", "description": "Retrieve a paginated list of the phone numbers assigned to a specific user in your Quo workspace.", "operationId": "listUserPhoneNumbers", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "description": "The unique identifier of the user whose phone numbers are being listed.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "query", "name": "include", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "restrictions" ] }, "description": "Comma-separated list of optional payload sections to include. `restrictions` adds the number’s calling and messaging restrictions. Omitted sections are left out of the response entirely. The members assigned to a number are their own endpoint, `GET /phone-numbers/{phoneNumberId}/users`.", "examples": [ "restrictions" ], "maxItems": 1, "uniqueItems": true }, "example": "restrictions" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "groupId", "name", "phoneNumber", "formattedNumber", "forward", "portRequestId", "portingStatus", "symbol", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the Quo phone number.", "examples": [ "PNlja6rrtI" ], "example": "PNlja6rrtI", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" }, "name": { "type": "string", "description": "The display name of the phone number.", "examples": [ "My phone number" ], "example": "My phone number" }, "phoneNumber": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of the phone number.", "examples": [ "(555) 555-5555" ], "example": "(555) 555-5555" }, { "type": "null" } ] }, "forward": { "anyOf": [ { "type": "string", "description": "Forwarding number for incoming calls, null if no forwarding number is configured.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "type": "null" } ] }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "portingStatus": { "anyOf": [ { "type": "string", "description": "Current status of the porting process, if applicable.", "examples": [ "completed" ], "example": "completed" }, { "type": "null" } ] }, "symbol": { "anyOf": [ { "type": "string", "description": "Custom symbol or emoji associated with the phone number.", "examples": [ "🏡" ], "example": "🏡" }, { "type": "null" } ] }, "createdAt": { "description": "Timestamp of when the phone number was added to the workspace, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "Timestamp of the last update to the phone number’s details, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "restrictions": { "type": "object", "required": [ "calling", "messaging" ], "properties": { "calling": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } }, "messaging": { "type": "object", "required": [ "CA", "Intl", "US" ], "properties": { "CA": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "Intl": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" }, "US": { "type": "string", "enum": [ "restricted", "unrestricted" ], "description": "The phone-number usage restriction status for a specific region.", "examples": [ "unrestricted" ], "example": "unrestricted" } } } } } } } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] }, "examples": { "UnexpectedError": { "summary": "Unexpected Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unexpected", "trace": "6897907457496870895" } }, "UnknownError": { "summary": "Unknown Error", "value": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } } } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Lists all webhooks", "description": "List all webhooks for an organization.", "operationId": "listHeaderVersionedWebhooks", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "message.received" ] ], "example": [ "message.received" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "call.completed" ] ], "example": [ "call.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] }, "minItems": 1, "description": "An event associated with the Webhook.", "examples": [ [ "call.summary.completed" ] ], "example": [ "call.summary.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "call.transcript.completed" ] ], "example": [ "call.transcript.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "contact.updated" ] ], "example": [ "contact.updated" ] }, "resourceIds": { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1, "description": "Contact webhooks are org-wide. This field is always [\"*\"].", "examples": [ [ "*" ] ], "example": [ "*" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "Events subscribed to by this webhook. Activity events (call.*, message.*) and org-wide events (contact.*) can be mixed freely.", "examples": [ [ "call.answered", "call.completed", "message.received", "contact.updated" ] ], "example": [ "call.answered", "call.completed", "message.received", "contact.updated" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ] } } } ] } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook", "description": "Creates a versioned webhook through the unified endpoint when using the API version header.", "operationId": "createHeaderVersionedWebhook", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events", "url" ], "properties": { "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "Events to subscribe to. Activity events (call.*, message.*) and org-wide events (contact.*) can be mixed freely.", "examples": [ [ "call.answered", "call.completed", "message.received", "contact.updated" ] ], "example": [ "call.answered", "call.completed", "message.received", "contact.updated" ] }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/webhook" ], "example": "https://example.com/webhook" }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" }, "minItems": 1 }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Omitting this field defaults to `[\"*\"]`. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "label": { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook" ], "example": "my webhook" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds", "key" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "Events subscribed to by this webhook. Activity events (call.*, message.*) and org-wide events (contact.*) can be mixed freely.", "examples": [ [ "call.answered", "call.completed", "message.received", "contact.updated" ] ], "example": [ "call.answered", "call.completed", "message.received", "contact.updated" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ] }, "key": { "type": "string", "description": "The webhook signing secret used to validate webhook signatures.", "examples": [ "whsec_exampleSecret" ], "example": "whsec_exampleSecret" } } } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] }, "examples": { "BadRequestError2": { "summary": "Bad Request", "value": { "message": "/url: Expected required property, /url: Expected string", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/url", "message": "Expected required property", "schema": { "type": "String" } }, { "path": "/url", "message": "Expected string", "schema": { "type": "String" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a webhook by ID", "description": "Get a webhook by its unique identifier.", "operationId": "getHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "message.received" ] ], "example": [ "message.received" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "call.completed" ] ], "example": [ "call.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] }, "minItems": 1, "description": "An event associated with the Webhook.", "examples": [ [ "call.summary.completed" ] ], "example": [ "call.summary.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "call.transcript.completed" ] ], "example": [ "call.transcript.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "contact.updated" ] ], "example": [ "contact.updated" ] }, "resourceIds": { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1, "description": "Contact webhooks are org-wide. This field is always [\"*\"].", "examples": [ [ "*" ] ], "example": [ "*" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "Events subscribed to by this webhook. Activity events (call.*, message.*) and org-wide events (contact.*) can be mixed freely.", "examples": [ [ "call.answered", "call.completed", "message.received", "contact.updated" ] ], "example": [ "call.answered", "call.completed", "message.received", "contact.updated" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ] } } } ] } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Update a webhook by ID", "description": "Partially update an existing webhook. Only the fields provided in the request body will be updated.", "operationId": "updateHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "An event associated with the webhook." }, "resourceIds": { "anyOf": [ { "type": "null" }, { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" }, "maxItems": 0 }, { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" }, "minItems": 1 }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "The unique identifiers of the phone numbers associated with the webhook. Pass null, [], or [\"*\"] to clear phone number filtering.", "examples": [ [ "PN1234" ], null, [] ], "example": [ "PN1234" ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "label": { "anyOf": [ { "type": "string", "description": "Webhook's label" }, { "type": "null" } ] } }, "minProperties": 1 } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "message.received" ] ], "example": [ "message.received" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "call.completed" ] ], "example": [ "call.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] }, "minItems": 1, "description": "An event associated with the Webhook.", "examples": [ [ "call.summary.completed" ] ], "example": [ "call.summary.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] }, "minItems": 1, "description": "The event associated with the webhook.", "examples": [ [ "call.transcript.completed" ] ], "example": [ "call.transcript.completed" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ], "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] }, "minItems": 1, "description": "An event associated with the webhook.", "examples": [ [ "contact.updated" ] ], "example": [ "contact.updated" ] }, "resourceIds": { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1, "description": "Contact webhooks are org-wide. This field is always [\"*\"].", "examples": [ [ "*" ] ], "example": [ "*" ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "type": "string", "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "example": "OR1223abc", "type": "string", "pattern": "^OR(.*)$" }, "label": { "anyOf": [ { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "url": { "type": "string", "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "minItems": 1, "description": "Events subscribed to by this webhook. Activity events (call.*, message.*) and org-wide events (contact.*) can be mixed freely.", "examples": [ [ "call.answered", "call.completed", "message.received", "contact.updated" ] ], "example": [ "call.answered", "call.completed", "message.received", "contact.updated" ] }, "resourceIds": { "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" }, "minItems": 1, "maxItems": 1 } ], "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ] } } } ] } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Bad Request", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] }, "examples": { "BadRequestError2": { "summary": "Bad Request", "value": { "message": "/url: Expected required property, /url: Expected string", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/url", "message": "Expected required property", "schema": { "type": "String" } }, { "path": "/url", "message": "Expected string", "schema": { "type": "String" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a webhook by ID", "description": "Delete a webhook by its unique identifier.", "operationId": "deleteHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}/rotate": { "post": { "tags": [ "Webhooks" ], "summary": "Rotate webhook signing secret", "description": "Rotates the signing secret for a webhook. The new secret will be returned in the response.", "operationId": "rotateHeaderVersionedWebhookSecret", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "key" ], "properties": { "key": { "type": "string", "description": "The webhook signing secret used to validate webhook signatures.", "examples": [ "whsec_exampleSecret" ], "example": "whsec_exampleSecret" } } } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}/events": { "get": { "tags": [ "Webhook Events" ], "summary": "List deliveries for a webhook", "description": "List deliveries for a webhook, including their delivery, event, and resource identifiers. Deliveries are sorted by `createdAt` descending, newest first. Use `resourceId` to find deliveries for a business object.", "operationId": "listHeaderVersionedWebhookDeliveries", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "query", "name": "limit", "required": false, "schema": { "type": "integer", "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "after", "required": false, "schema": { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ] }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Current delivery status of the event: `success` once any attempt succeeded, `pending` before the first attempt, `sending` mid-retry, or `failed` after all retries are exhausted.", "examples": [ "success" ] }, "example": "success" }, { "in": "query", "name": "eventTypes", "required": false, "schema": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ] }, "minItems": 1, "description": "DEPRECATED, use `eventType` instead. Will still work, but if both are provided, their values are combined and deduplicated. Restrict results to deliveries of these event types.", "deprecated": true, "examples": [ [ "message.received" ] ] }, "example": [ "message.received" ] }, { "in": "query", "name": "eventType", "required": false, "schema": { "anyOf": [ { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ] }, { "type": "object", "required": [ "in" ], "properties": { "in": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ] }, "description": "Match deliveries of any of these event types.", "examples": [ "message.received,call.completed" ] } }, "additionalProperties": false } ], "description": "Filter by event type, such as `eventType=message.received`. To match any of several, use `eventType[in]=message.received,call.completed`.", "examples": [ "message.received" ] }, "style": "deepObject", "explode": true, "example": "message.received" }, { "in": "query", "name": "resourceId", "required": false, "schema": { "type": "string", "minLength": 1, "description": "Only include deliveries for this exact resource ID. This filter does not match deliveries created before September 1, 2026.", "examples": [ "ACsampleactivity0000000000000000" ] }, "example": "ACsampleactivity0000000000000000" }, { "in": "query", "name": "createdAt", "required": false, "schema": { "type": "object", "properties": { "gt": { "description": "Only return deliveries dispatched after this timestamp.", "examples": [ "2026-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "lt": { "description": "Only return deliveries dispatched before this timestamp.", "examples": [ "2026-01-02T00:00:00Z" ], "type": "string", "format": "date-time" } }, "additionalProperties": false, "description": "Bound the results by dispatch time, in ISO 8601 format: `createdAt[gt]=2026-01-01T00:00:00Z&createdAt[lt]=2026-02-01T00:00:00Z`. Both bounds are exclusive.", "examples": [ { "gt": "2026-01-01T00:00:00Z" } ] }, "style": "deepObject", "explode": true, "example": { "gt": "2026-01-01T00:00:00Z" } }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "description": "DEPRECATED, use `createdAt[lt]` instead. Only include deliveries dispatched before this timestamp.", "deprecated": true, "examples": [ "2026-01-02T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2026-01-02T00:00:00Z" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "description": "DEPRECATED, use `createdAt[gt]` instead. Only include deliveries dispatched after this timestamp.", "deprecated": true, "examples": [ "2026-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2026-01-01T00:00:00Z" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "eventId", "resourceId", "eventType", "status", "nextAttemptAt", "createdAt" ], "properties": { "id": { "type": "string", "description": "The delivery identifier. This value matches the `webhook-id` header.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "example": "msg_2abcDEFghiJKLmnoPQRstu" }, "eventId": { "anyOf": [ { "type": "string", "description": "The stable event identifier from the webhook payload `id`. `null` for deliveries created before September 1, 2026 and for test deliveries.", "examples": [ "2abcDEFghiJKLmnoPQRstu45" ], "example": "2abcDEFghiJKLmnoPQRstu45" }, { "type": "null" } ] }, "resourceId": { "anyOf": [ { "type": "string", "description": "The primary resource identifier in the event payload. Call summary, transcript, and voicemail events use their source call ID. `null` for deliveries created before September 1, 2026 and for test deliveries.", "examples": [ "ACsampleactivity0000000000000000" ], "example": "ACsampleactivity0000000000000000" }, { "type": "null" } ] }, "eventType": { "type": "string", "description": "The event type that was delivered. Typically one of `call.answered`, `call.completed`, `call.menu.selected`, `call.ringing`, `call.recording.completed`, `call.summary.completed`, `call.transcript.completed`, `message.received`, `message.delivered`, `message.failed`, `message.undelivered`, `contact.created`, `contact.updated`, `contact.deleted`, `a2p.registration.updated`. `message.failed` indicates a send failure (retriable unless an error code marks it permanent), while `message.undelivered` indicates the message could not be delivered to the recipient or was blocked, and cannot be retried. Legacy webhooks may return other stored names.", "examples": [ "message.received" ], "example": "message.received" }, "status": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Current delivery status of the event: `success` once any attempt succeeded, `pending` before the first attempt, `sending` mid-retry, or `failed` after all retries are exhausted.", "examples": [ "success" ], "example": "success" }, "nextAttemptAt": { "anyOf": [ { "description": "The next scheduled retry time in ISO 8601 format. `null` when no further attempts are scheduled (terminal states).", "examples": [ "2026-01-01T00:05:00Z" ], "example": "2026-01-01T00:05:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "createdAt": { "description": "The date the event was dispatched at, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "example": "2026-01-01T00:00:00Z", "type": "string", "format": "date-time" } } } }, "nextCursor": { "anyOf": [ { "type": "string", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "type": "null" } ] } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}/events/{deliveryId}": { "get": { "tags": [ "Webhook Events" ], "summary": "Get webhook delivery details", "description": "Get one delivery by its delivery ID, including the original request body and the server response for each attempt.", "operationId": "getHeaderVersionedWebhookDelivery", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "path", "name": "deliveryId", "required": true, "schema": { "type": "string", "description": "The delivery identifier, returned as `id` by the delivery list endpoint and sent in the `webhook-id` header. This is not the payload `eventId`.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ] }, "example": "msg_2abcDEFghiJKLmnoPQRstu" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "eventId", "resourceId", "eventType", "createdAt", "requestBody", "attempts" ], "properties": { "id": { "type": "string", "description": "The delivery identifier. This value matches the `webhook-id` header.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "example": "msg_2abcDEFghiJKLmnoPQRstu" }, "eventId": { "anyOf": [ { "type": "string", "description": "The stable event identifier from the webhook payload `id`. `null` for deliveries created before September 1, 2026 and for test deliveries.", "examples": [ "2abcDEFghiJKLmnoPQRstu45" ], "example": "2abcDEFghiJKLmnoPQRstu45" }, { "type": "null" } ] }, "resourceId": { "anyOf": [ { "type": "string", "description": "The primary resource identifier in the event payload. Call summary, transcript, and voicemail events use their source call ID. `null` for deliveries created before September 1, 2026 and for test deliveries.", "examples": [ "ACsampleactivity0000000000000000" ], "example": "ACsampleactivity0000000000000000" }, { "type": "null" } ] }, "eventType": { "type": "string", "description": "The event type that was delivered.", "examples": [ "message.received" ], "example": "message.received" }, "createdAt": { "description": "The date the event was dispatched at, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "example": "2026-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "requestBody": { "description": "The event payload that was sent to the webhook.", "examples": [ { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "orgId": "ORsampleorg000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } ], "example": { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "orgId": "ORsampleorg000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } }, "attempts": { "type": "array", "items": { "type": "object", "required": [ "id", "timestamp", "status", "responseStatusCode", "responseBody", "responseDurationMs", "triggerType", "url" ], "properties": { "id": { "type": "string", "description": "The unique identifier of this delivery attempt.", "examples": [ "atmpt_2abcDEFghiJKLmnoPQRstu" ], "example": "atmpt_2abcDEFghiJKLmnoPQRstu" }, "timestamp": { "description": "When this attempt was made, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "example": "2026-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Outcome of this specific attempt: `success` if the destination returned a 2xx, `failed` if it returned a non-2xx or no response, `sending` if the attempt is in flight, or `pending` if it is queued to run.", "examples": [ "success" ], "example": "success" }, "responseStatusCode": { "type": "integer", "description": "HTTP status code returned by the destination server. `0` if no response was received.", "examples": [ 200 ], "example": 200 }, "responseBody": { "type": "string", "description": "The raw response body returned by the destination server.", "examples": [ "{\"ok\":true}" ], "example": "{\"ok\":true}" }, "responseDurationMs": { "type": "number", "description": "Time taken for the destination server to respond, in milliseconds.", "examples": [ 123 ], "example": 123 }, "triggerType": { "type": "string", "enum": [ "scheduled", "manual" ], "description": "`scheduled` for automatic retries, `manual` for operator-initiated replays.", "examples": [ "scheduled" ], "example": "scheduled" }, "url": { "type": "string", "description": "The destination URL this attempt was sent to.", "examples": [ "https://example.com/webhook" ], "example": "https://example.com/webhook" } } }, "description": "Attempts made to deliver this event to the webhook, ordered most-recent first." } } } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}/events/{deliveryId}/retry": { "post": { "tags": [ "Webhook Events" ], "summary": "Retry a webhook delivery", "description": "Queue a new attempt for a delivery. The retry is processed asynchronously; use the delivery detail endpoint to inspect the new attempt.", "operationId": "retryHeaderVersionedWebhookDelivery", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "path", "name": "deliveryId", "required": true, "schema": { "type": "string", "description": "The delivery identifier, returned as `id` by the delivery list endpoint and sent in the `webhook-id` header. This is not the payload `eventId`.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ] }, "example": "msg_2abcDEFghiJKLmnoPQRstu" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Id", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" }, { "$ref": "#/components/schemas/InvalidIdError" } ] }, "examples": { "InvalidIdError": { "summary": "Invalid Id", "value": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } }, "/webhooks/{webhookId}/events/test": { "post": { "tags": [ "Webhook Events" ], "summary": "Send a test event to a webhook", "description": "Dispatches a canonical sample payload of the specified event type to the webhook URL so you can validate your endpoint before going live. The response returns the rendered sample payload so you can preview the body your endpoint will receive. Delivery to your URL is processed asynchronously; use the delivery detail endpoint to inspect the attempt.", "operationId": "sendHeaderVersionedTestWebhookEvent", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "type": "string", "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "eventType" ], "properties": { "eventType": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "apiVersion", "type", "createdAt", "data" ], "properties": { "id": { "type": "string", "description": "The event identifier inside the dispatched payload body — matches the `id` your endpoint will receive on the webhook POST. Note: this is a fixed sample identifier shared across test dispatches, not a per-delivery Svix message ID.", "examples": [ "2abcDEFghiJKLmnoPQRstu45" ], "example": "2abcDEFghiJKLmnoPQRstu45" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The webhook payload version used to render this event.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "type": { "type": "string", "enum": [ "message.received", "message.delivered", "message.failed", "message.undelivered", "call.ringing", "call.answered", "call.completed", "call.missed", "call.forwarded", "call.menu.selected", "call.recording.completed", "call.transcript.completed", "call.summary.completed", "call.voicemail.completed", "contact.created", "contact.updated", "contact.deleted", "integration.created", "integration.updated", "integration.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked", "a2p.registration.updated" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "createdAt": { "type": "string", "format": "date-time", "description": "When the test event was created." }, "data": { "description": "Event-specific body. Shape depends on `type` — see the webhook event documentation.", "examples": [ { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "orgId": "ORsampleorg000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } ], "example": { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "orgId": "ORsampleorg000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } } } } } } }, "400": { "description": "Invalid Resource Id Type | Input Too Long | Bad Request | Invalid Input Format | Invalid Version | Invalid Input Format", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] }, "examples": { "InvalidInputFormatError": { "summary": "Invalid Input Format", "value": { "message": "Invalid input format", "docs": "https://quo.com/docs", "title": "Invalid Input Format" } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300401" }, "status": { "type": "number", "const": 401 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300403" }, "status": { "type": "number", "const": 403 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300404" }, "status": { "type": "number", "const": 404 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Found" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] }, "examples": { "UnexpectedError2": { "summary": "Unexpected Error", "value": { "message": "An unexpected error occurred", "docs": "https://quo.com/docs", "title": "Unexpected Error" } }, "UnknownError2": { "summary": "Unknown Error", "value": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } } } }, "components": { "schemas": { "SubscriptionExpiredError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Subscription Expired" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Subscription Expired" }, "PaymentFailedError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Payment Failed" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Payment Failed" }, "UnexpectedError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Unexpected Error" }, "UnknownError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unknown" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Unknown Error" }, "BadRequestError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Bad Request" }, "InvalidToPhoneNumberError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid `to` Phone Number" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Invalid `to` Phone Number" }, "UnreachableToPhoneNumberError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unreachable `to` Phone Number" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Unreachable `to` Phone Number" }, "UserOptedOutError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "User Opted Out" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "User Opted Out" }, "NotTFNRegisteredError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not TFN Registered" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Not TFN Registered" }, "A2PRegistrationNotApprovedError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "A2P Registration Not Approved" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "A2P Registration Not Approved" }, "ForbiddenError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Forbidden" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Forbidden" }, "NotPhoneNumberUserError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Phone Number User" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Not Phone Number User" }, "A2P10DLCDailyMessageCapReachedError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "A2P 10DLC Daily Message Cap Reached" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "A2P 10DLC Daily Message Cap Reached" }, "InternationalMessagingNotAllowedError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "International Messaging Not Allowed" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "International Messaging Not Allowed" }, "NotEnoughCreditsError": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Not Enough Credits" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "properties": { "type": { "type": "string" } } } } } } }, "title": "Not Enough Credits" }, "UnexpectedError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300500" }, "status": { "type": "number", "const": 500 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unexpected" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Unexpected Error" }, "UnknownError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0301500" }, "status": { "type": "number", "const": 500 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Unknown" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Unknown Error" }, "InvalidResourceIdTypeError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0301400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid Resource Id Type" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Invalid Resource Id Type" } }, "title": "Invalid Resource Id Type" }, "InputTooLongError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0302400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Input Too Long" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Input Too Long" } }, "title": "Input Too Long" }, "BadRequestError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0300400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Bad Request" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Bad Request" }, "InvalidInputFormatError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0304400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid Input Format" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Invalid Input Format" } }, "title": "Invalid Input Format" }, "InvalidVersionError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0305400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid Version" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Invalid Version" } }, "title": "Invalid Version" }, "InvalidIdError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0303400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid Id" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Invalid Id" } }, "title": "Invalid Id" } }, "securitySchemes": { "apiKey": { "in": "header", "name": "Authorization", "type": "apiKey" } } }, "servers": [ { "description": "Production server", "url": "https://api.quo.com" } ], "tags": [ { "description": "Operations related to the organization's A2P registration", "name": "A2P Registration" }, { "description": "Operations related to calls placed by an AI agent", "name": "Agent Calls" }, { "description": "Operations related to text conversations held by an AI agent", "name": "Agent Conversations" }, { "description": "Operations related to calls", "name": "Calls" }, { "description": "Operations related to call summaries, including AI-generated summaries and Sona voice assistant summaries", "name": "Call Summaries" }, { "description": "Operations related to call transcripts, including AI-generated transcripts and Sona voice assistant transcripts", "name": "Call Transcripts" }, { "description": "Operations related to contacts", "name": "Contacts" }, { "description": "Operations related to contact shares", "name": "Contact Shares" }, { "description": "Operations related to contact notes", "name": "Contact Notes" }, { "description": "Operations related to contact properties", "name": "Contact Properties" }, { "description": "Operations related to conversations", "name": "Conversations" }, { "description": "Operations related to workspace invitations", "name": "Invites" }, { "description": "Operations related to text messages", "name": "Messages" }, { "description": "Operations related to the organization", "name": "Organization" }, { "description": "Operations related to phone numbers", "name": "Phone Numbers" }, { "description": "Operations related to users", "name": "Users" }, { "description": "Operations related to webhooks", "name": "Webhooks" }, { "description": "Operations related to webhook events, including delivery history and test events", "name": "Webhook Events" } ], "security": [ { "apiKey": [] } ] }