{ "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": { "/v1/call-recordings/{callId}": { "get": { "tags": [ "Calls" ], "summary": "Get recordings for a call", "description": "Retrieve a list of recordings associated with a specific call. The results are sorted chronologically, with the oldest recording segment appearing first in the list.", "operationId": "getCallRecordings_v1", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "The unique identifier of the call for which recordings are being retrieved.", "examples": [ "AC3700e624eca547eb9f749a06f" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "duration", "id", "startTime", "status", "type", "url" ], "properties": { "duration": { "anyOf": [ { "type": "integer", "description": "The length of the call recording in seconds. Null if the recording is not completed or the duration is unknown.", "examples": [ 60 ], "example": 60 }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the call recording.", "examples": [ "CRwRVK2qBq" ], "example": "CRwRVK2qBq" }, "startTime": { "anyOf": [ { "description": "The timestamp when the recording began, in ISO 8601 format. Null if the recording hasn't started or the start time is unknown.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "status": { "anyOf": [ { "type": "string", "enum": [ "absent", "completed", "deleted", "failed", "in-progress", "paused", "processing", "stopped", "stopping" ], "description": "The current status of the call recording.", "examples": [ "completed" ], "example": "completed" }, { "type": "null" } ] }, "type": { "anyOf": [ { "type": "string", "description": "The file type of the call recording. Null if the type is not specified or is unknown.", "examples": [ "audio/mpeg" ], "example": "audio/mpeg" }, { "type": "null" } ] }, "url": { "anyOf": [ { "type": "string", "description": "The URL where the call recording can be accessed or downloaded. Null if the URL is not available or the recording is not accessible.", "examples": [ "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" ], "format": "uri-reference", "example": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" }, { "type": "null" } ] } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0900400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0900401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0900403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0900404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError" }, { "$ref": "#/components/schemas/UnknownError" } ] } } } } } } }, "/v1/calls": { "get": { "tags": [ "Calls" ], "summary": "List calls", "description": "Fetch a paginated list of calls associated with a specific Quo number and another number.", "operationId": "listCalls_v1", "parameters": [ { "in": "query", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the Quo number associated with the call.", "examples": [ "PN123abc" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PN123abc" }, { "in": "query", "name": "userId", "required": false, "schema": { "description": "The unique identifier of the user whose access scope is applied to the results. Scopes the response to calls accessible to the specified user. Defaults to the workspace owner.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" }, { "in": "query", "name": "participants", "required": true, "schema": { "type": "array", "items": { "type": "string", "minLength": 1 }, "maxItems": 1, "description": "The phone numbers of participants involved in the call conversation, excluding your Quo number. Each number should contain the country code and conform to the E.164 format. Currently limited to one-to-one (1:1) conversations only. Pass the \"participants\" key without brackets, e.g. \"participants=%2B15555555555\".", "examples": [ "+15555555555" ] }, "example": "+15555555555" }, { "in": "query", "name": "since", "required": false, "schema": { "deprecated": true, "description": "DEPRECATED, use \"createdAfter\" or \"createdBefore\" instead. \"since\" incorrectly behaves as \"createdBefore\" and will be removed in an upcoming release.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "description": "Filter results to only include calls created after the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "description": "Filter results to only include calls created before the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "maxResults", "required": true, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 10, "maximum": 100, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems", "nextPageToken" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "answeredAt", "answeredBy", "initiatedBy", "direction", "status", "completedAt", "createdAt", "callRoute", "duration", "forwardedFrom", "forwardedTo", "aiHandled", "id", "phoneNumberId", "participants", "updatedAt", "userId" ], "properties": { "answeredAt": { "anyOf": [ { "description": "The timestamp when the call was answered in ISO 8601 format. Null if the call was not answered.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "answeredBy": { "anyOf": [ { "type": "string", "description": "The unique identifier of the Quo user who answered the incoming call. Null for outgoing calls or unanswered incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz" }, { "type": "null" } ] }, "initiatedBy": { "anyOf": [ { "type": "string", "description": "The unique identifier of the Quo user who initiated the outgoing call. Null for incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz" }, { "type": "null" } ] }, "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" }, "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" }, "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": [ { "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": "^US(.*)$" } ], "description": "The phone number or Quo user ID from which the call was forwarded. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "forwardedTo": { "anyOf": [ { "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(.*)$" } ], "description": "The phone number, Quo phone number ID, or Quo user ID to which the call was forwarded. Null if the call was not forwarded.", "examples": [ "+15555555555", "PN123abc", "US123abc" ], "example": "+15555555555" }, { "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" } ] }, "id": { "description": "The unique identifier of the call.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "phoneNumberId": { "description": "The unique identifier of the Quo number associated with the call.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "participants": { "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}$", "example": "+15555555555" }, "maxItems": 2, "description": "An array of phone numbers involved in the call, including the Quo number. Each number includes the country code and conforms to the E.164 format. Currently limited to one-to-one conversations.", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "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" } ] }, "userId": { "description": "The unique identifier of the Quo user account associated with the call.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } }, "description": "Array of items" }, "totalItems": { "type": "integer", "description": "Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue." }, "nextPageToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request | Too Many Participants", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/TooManyParticipantsError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] } } } } } } }, "/v1/calls/{callId}": { "get": { "tags": [ "Calls" ], "summary": "Get a call by ID", "description": "Get a call by its unique identifier.", "operationId": "getCallById_v1", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "Unique identifier of the call.", "examples": [ "AC3700e624eca547eb9f749a06f2eb1" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f2eb1" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "answeredAt", "answeredBy", "initiatedBy", "direction", "status", "completedAt", "createdAt", "callRoute", "duration", "forwardedFrom", "forwardedTo", "aiHandled", "id", "phoneNumberId", "participants", "updatedAt", "userId" ], "properties": { "answeredAt": { "anyOf": [ { "description": "The timestamp when the call was answered in ISO 8601 format. Null if the call was not answered.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "answeredBy": { "anyOf": [ { "type": "string", "description": "The unique identifier of the Quo user who answered the incoming call. Null for outgoing calls or unanswered incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz" }, { "type": "null" } ] }, "initiatedBy": { "anyOf": [ { "type": "string", "description": "The unique identifier of the Quo user who initiated the outgoing call. Null for incoming calls.", "examples": [ "USlHhXmRMz" ], "example": "USlHhXmRMz" }, { "type": "null" } ] }, "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" }, "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" }, "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": [ { "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": "^US(.*)$" } ], "description": "The phone number or Quo user ID from which the call was forwarded. Null if the call was not forwarded.", "examples": [ "US123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "forwardedTo": { "anyOf": [ { "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(.*)$" } ], "description": "The phone number, Quo phone number ID, or Quo user ID to which the call was forwarded. Null if the call was not forwarded.", "examples": [ "+15555555555", "PN123abc", "US123abc" ], "example": "+15555555555" }, { "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" } ] }, "id": { "description": "The unique identifier of the call.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "phoneNumberId": { "description": "The unique identifier of the Quo number associated with the call.", "examples": [ "PN123abc" ], "example": "PN123abc", "type": "string", "pattern": "^PN(.*)$" }, "participants": { "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}$", "example": "+15555555555" }, "maxItems": 2, "description": "An array of phone numbers involved in the call, including the Quo number. Each number includes the country code and conforms to the E.164 format. Currently limited to one-to-one conversations.", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "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" } ] }, "userId": { "description": "The unique identifier of the Quo user account associated with the call.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request | Too Many Participants", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError" }, { "$ref": "#/components/schemas/TooManyParticipantsError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError2" }, { "$ref": "#/components/schemas/UnknownError2" } ] } } } } } } }, "/v1/call-summaries/{callId}": { "get": { "tags": [ "Calls" ], "summary": "Get a summary for a call", "description": "Retrieve a detailed summary of a specific call identified by its unique call ID. This endpoint supports summaries for both regular calls and calls handled by Sona. Call summaries are only available on business and scale plans.", "operationId": "getCallSummary_v1", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "The unique identifier of the call associated with the summary.", "examples": [ "AC3700e624eca547eb9f749a06f" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "callId", "nextSteps", "status", "summary" ], "properties": { "callId": { "type": "string", "description": "The unique identifier of the call to which this summary belongs.", "examples": [ "ACea724hac8c30465bcbcff0b76e4c1c7b" ], "example": "ACea724hac8c30465bcbcff0b76e4c1c7b" }, "nextSteps": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "Bring an umbrella." ], "example": "Bring an umbrella." }, "description": "An array of suggested next actions or follow-up items derived from the call content. Null if no next steps were identified or if no call summary is available." }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "absent", "in-progress", "completed", "failed" ], "description": "The status of the call summary.", "examples": [ "completed" ], "example": "completed" }, "summary": { "anyOf": [ { "type": "array", "items": { "type": "string", "examples": [ "You talked about the weather." ], "example": "You talked about the weather." }, "description": "An array of statements that encapsulate the key points or main topics discussed during the call. For Sona-generated summaries, this includes structured Q&A pairs. Null if the summary is not yet generated or if no call summary is available." }, { "type": "null" } ] }, "jobs": { "anyOf": [ { "description": "Structured job results from Sona, Quo's AI voice assistant. Contains Q&A pairs, task completions, and other job-specific data collected during the call. Only present for calls handled by Sona.", "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" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0500400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0500401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0500403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0500404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError3" }, { "$ref": "#/components/schemas/UnknownError3" } ] } } } } } } }, "/v1/call-transcripts/{id}": { "get": { "tags": [ "Calls" ], "summary": "Get a transcription for a call", "description": "Retrieve a detailed transcript of a specific call identified by its unique call ID. This endpoint supports transcripts for both regular calls and calls handled by Sona. Call transcripts are only available on business and scale plans.", "operationId": "getCallTranscript_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "Unique identifier of the call associated with this transcript.", "examples": [ "AC3700e624eca547eb9f749a06f2eb1" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f2eb1" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "callId", "createdAt", "dialogue", "duration", "status" ], "properties": { "callId": { "type": "string", "description": "The unique identifier of the call to which this transcript belongs.", "examples": [ "ACea724hac8c30465bcbcff0b76e4c1c7b" ], "example": "ACea724hac8c30465bcbcff0b76e4c1c7b" }, "createdAt": { "description": "The timestamp when the transcription was created, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "dialogue": { "anyOf": [ { "type": "array", "items": { "type": "object", "required": [ "content", "start", "end", "identifier", "userId" ], "properties": { "content": { "type": "string", "description": "The transcribed text of a specific dialogue segment.", "examples": [ "Hello, world!" ], "example": "Hello, world!" }, "start": { "type": "number", "description": "The start time of the dialogue segment in seconds, relative to the beginning of the call.", "examples": [ 5.123456 ], "example": 5.123456 }, "end": { "type": "number", "description": "The end time of the dialogue segment in seconds, relative to the beginning of the call.", "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" } ] }, "userId": { "anyOf": [ { "description": "The unique identifier of the Quo user who spoke during this dialogue segment. Null for external participants or if user identification is not available.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] } } }, "description": "An array of objects representing individual segments of the transcribed conversation. Null if the transcription is not available or in progress." }, { "type": "null" } ] }, "duration": { "type": "number", "description": "The total duration of the transcribed call in seconds.", "examples": [ 100 ], "example": 100 }, "status": { "type": "string", "enum": [ "absent", "in-progress", "completed", "failed" ], "description": "The status of the call transcription.", "examples": [ "completed" ], "example": "completed" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError4" } ] } } } } } } }, "/v1/call-voicemails/{callId}": { "get": { "tags": [ "Calls" ], "summary": "Get a voicemail for a call", "description": "Retrieve a voicemail associated with a specific call. Returns null data fields while the voicemail is processing in our system. Returns competed data fields when the voicemail has finished processing.", "operationId": "getCallVoicemails_v1", "parameters": [ { "in": "path", "name": "callId", "required": true, "schema": { "description": "The unique identifier of the call for which a voicemail is being retrieved.", "examples": [ "AC3700e624eca547eb9f749a06f" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC3700e624eca547eb9f749a06f" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "duration", "id", "transcript", "recordingUrl", "status" ], "properties": { "duration": { "anyOf": [ { "type": "integer", "description": "The length of the call voicemail in seconds. Null if the voicemail is not completed or the duration is unknown.", "examples": [ 60 ], "example": 60 }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the call voicemail.", "examples": [ "VMaaff8f317e0c4e61953b74a5eb42a370" ], "example": "VMaaff8f317e0c4e61953b74a5eb42a370", "type": "string", "pattern": "^VM(.*)$" }, "transcript": { "anyOf": [ { "type": "string", "description": "The transcript of the call voicemail. Null if the voicemail is not completed or the transcript is not available.", "examples": [ "Hello, this is a voicemail from John Doe." ], "example": "Hello, this is a voicemail from John Doe." }, { "type": "null" } ] }, "recordingUrl": { "anyOf": [ { "type": "string", "description": "The URL where the call voicemail can be accessed or downloaded. Null if the voicemail is not completed or the URL is not available.", "examples": [ "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" ], "format": "uri", "example": "https://examplestorage.com/a643d4d3e1484fcc8b721627284eda5e.mp3" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "completed", "in-progress" ], "description": "The current status of the call voicemail.", "examples": [ "completed", "in-progress" ], "example": "completed" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1200400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1200401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1200403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1200404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError5" }, { "$ref": "#/components/schemas/UnknownError5" } ] } } } } } } }, "/v1/contact-custom-fields": { "get": { "tags": [ "Contact Custom Fields" ], "summary": "Get contact custom fields", "description": "Custom contact fields enhance your Quo contacts with additional information beyond standard details like name, company, role, emails and phone numbers. These user-defined fields let you capture business-specific data. While you can only create or modify these fields in Quo itself, this endpoint retrieves your existing custom properties. Use this information to accurately map and include important custom data when creating new contacts via the API.", "operationId": "getContactCustomFields_v1", "parameters": [], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "name", "key", "type" ], "properties": { "name": { "type": "string", "description": "The name of the custom contact field. This name is set by users in the Quo interface when the custom field is created.", "examples": [ "Inbound Lead" ], "example": "Inbound Lead" }, "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" }, "type": { "type": "string", "enum": [ "address", "boolean", "date", "multi-select", "number", "string", "url" ], "description": "The data type of the custom contact field, determining what kind of information can be stored and how it should be formatted.", "examples": [ "boolean" ], "example": "boolean" } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0700400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0700401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0700403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0700404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError6" }, { "$ref": "#/components/schemas/UnknownError6" } ] } } } } } } }, "/v1/contacts": { "post": { "tags": [ "Contacts" ], "summary": "Create a contact", "description": "Create a contact for a workspace.", "operationId": "createContact_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "defaultFields" ], "properties": { "defaultFields": { "type": "object", "required": [ "firstName" ], "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address.", "examples": [ "abc@example.com" ], "example": "abc@example.com" }, { "type": "null" } ] } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number.", "examples": [ "+12345678901" ], "example": "+12345678901" }, { "type": "null" } ] } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" } } }, { "anyOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } }, "createdByUserId": { "description": "The unique identifier of the user who created the contact.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "source": { "type": "string", "description": "The contact's source. Defaults to `null` for contacts created in the UI. Defaults to `public-api` for contacts created via the public API. Cannot be one of the following reserved words: `openphone`, `device`, `csv`, `zapier`, `google-people`, `other` or start with one of the following reserved prefixes: `openphone`, `csv`.", "examples": [ "public-api", "custom-hubspot", "google-calendar" ], "default": "public-api", "minLength": 1, "maxLength": 72, "example": "public-api" }, "sourceUrl": { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "externalId", "source", "sourceUrl", "defaultFields", "customFields", "createdAt", "updatedAt", "createdByUserId" ], "properties": { "id": { "description": "The unique identifier of the contact.", "examples": [ "664d0db69fcac7cf2e6ec" ], "example": "664d0db69fcac7cf2e6ec", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75, "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "defaultFields": { "type": "object", "required": [ "company", "emails", "firstName", "lastName", "phoneNumbers", "role" ], "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address.", "examples": [ "abc@example.com" ], "example": "abc@example.com" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier for the contact email field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number.", "examples": [ "+12345678901" ], "example": "+12345678901" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the contact phone number field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the custom contact field. This name is set by users in the Quo interface when the custom field is created.", "examples": [ "Inbound Lead" ], "example": "Inbound Lead" }, "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" }, "id": { "type": "string", "description": "The unique identifier for the contact custom field.", "examples": [ "66d0d87d534de8fd1c433cec3" ], "example": "66d0d87d534de8fd1c433cec3" } } }, { "anyOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "multi-select" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "address", "string", "url" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } }, "createdAt": { "description": "Timestamp of contact 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 contact update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "The unique identifier of the user who created the contact.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request | Invalid Custom Field Item", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidCustomFieldItemError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError2" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800404" }, "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" } } } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800409" }, "status": { "type": "number", "const": 409 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError7" }, { "$ref": "#/components/schemas/UnknownError7" } ] } } } } } }, "get": { "tags": [ "Contacts" ], "summary": "List contacts", "description": "Retrieve a paginated list of contacts. You can optionally filter the results by providing external IDs and sources. When no external IDs are provided, all contacts for the organization are returned.", "operationId": "listContacts_v1", "parameters": [ { "in": "query", "name": "externalIds", "required": false, "schema": { "type": "array", "items": { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75 }, "description": "Optional list of unique identifiers from an external system used to retrieve specific contacts. When provided, the result set is limited to contacts associated with the provided `externalIds`. These IDs must match those supplied during contact creation via the \"Create Contacts\" endpoint. When omitted, returns all contacts for the organization. Use this parameter to cross-reference and fetch contacts linked to external systems." } }, { "in": "query", "name": "sources", "required": false, "schema": { "type": "array", "items": { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75 } } }, { "in": "query", "name": "maxResults", "required": true, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems", "nextPageToken" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "externalId", "source", "sourceUrl", "defaultFields", "customFields", "createdAt", "updatedAt", "createdByUserId" ], "properties": { "id": { "description": "The unique identifier of the contact.", "examples": [ "664d0db69fcac7cf2e6ec" ], "example": "664d0db69fcac7cf2e6ec", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75, "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "defaultFields": { "type": "object", "required": [ "company", "emails", "firstName", "lastName", "phoneNumbers", "role" ], "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address.", "examples": [ "abc@example.com" ], "example": "abc@example.com" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier for the contact email field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number.", "examples": [ "+12345678901" ], "example": "+12345678901" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the contact phone number field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the custom contact field. This name is set by users in the Quo interface when the custom field is created.", "examples": [ "Inbound Lead" ], "example": "Inbound Lead" }, "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" }, "id": { "type": "string", "description": "The unique identifier for the contact custom field.", "examples": [ "66d0d87d534de8fd1c433cec3" ], "example": "66d0d87d534de8fd1c433cec3" } } }, { "anyOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "multi-select" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "address", "string", "url" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } }, "createdAt": { "description": "Timestamp of contact 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 contact update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "The unique identifier of the user who created the contact.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } }, "description": "Array of items" }, "totalItems": { "type": "integer", "description": "Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue." }, "nextPageToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request | Invalid Custom Field Item", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidCustomFieldItemError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError2" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800404" }, "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" } } } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800409" }, "status": { "type": "number", "const": 409 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError7" }, { "$ref": "#/components/schemas/UnknownError7" } ] } } } } } } }, "/v1/contacts/{id}": { "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_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "66d0d87e8dc1211467372303" ], "type": "string", "pattern": "^(.*)$" }, "example": "66d0d87e8dc1211467372303" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "externalId", "source", "sourceUrl", "defaultFields", "customFields", "createdAt", "updatedAt", "createdByUserId" ], "properties": { "id": { "description": "The unique identifier of the contact.", "examples": [ "664d0db69fcac7cf2e6ec" ], "example": "664d0db69fcac7cf2e6ec", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75, "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "defaultFields": { "type": "object", "required": [ "company", "emails", "firstName", "lastName", "phoneNumbers", "role" ], "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address.", "examples": [ "abc@example.com" ], "example": "abc@example.com" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier for the contact email field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number.", "examples": [ "+12345678901" ], "example": "+12345678901" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the contact phone number field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the custom contact field. This name is set by users in the Quo interface when the custom field is created.", "examples": [ "Inbound Lead" ], "example": "Inbound Lead" }, "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" }, "id": { "type": "string", "description": "The unique identifier for the contact custom field.", "examples": [ "66d0d87d534de8fd1c433cec3" ], "example": "66d0d87d534de8fd1c433cec3" } } }, { "anyOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "multi-select" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "address", "string", "url" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } }, "createdAt": { "description": "Timestamp of contact 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 contact update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "The unique identifier of the user who created the contact.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request | Invalid Custom Field Item", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidCustomFieldItemError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError2" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800404" }, "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" } } } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800409" }, "status": { "type": "number", "const": 409 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError7" }, { "$ref": "#/components/schemas/UnknownError7" } ] } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a contact by ID", "description": "Modify an existing contact in your Quo workspace using the contact's unique identifier. This endpoint replaces the contact rather than merging into it: any defaultFields.emails, defaultFields.phoneNumbers or customFields you omit from the request body is deleted on the contact. Always send the full set of fields, emails, and phone numbers you want the contact to have, not just the ones you're changing.", "operationId": "updateContactById_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "66d0d87e8dc1211467372303" ], "type": "string", "pattern": "^(.*)$" }, "example": "66d0d87e8dc1211467372303" } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75, "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "defaultFields": { "type": "object", "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address. Setting this to null removes the email item from the contact. Note that omitting the `emails` array entirely from a PATCH request also removes all of the contact's existing emails, since this endpoint replaces the full list rather than merging into it.", "examples": [ "info@openphone.com" ], "example": "info@openphone.com" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier for the contact email field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number. Setting this to null removes the phone number item from the contact. Note that omitting the `phoneNumbers` array entirely from a PATCH request also removes all of the contact's existing phone numbers, since this endpoint replaces the full list rather than merging into it.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the contact phone number field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "properties": { "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" }, "id": { "type": "string", "description": "The unique identifier for the contact custom field.", "examples": [ "66d0d87d534de8fd1c433cec3" ], "example": "66d0d87d534de8fd1c433cec3" } } }, { "anyOf": [ { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "value" ], "properties": { "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "externalId", "source", "sourceUrl", "defaultFields", "customFields", "createdAt", "updatedAt", "createdByUserId" ], "properties": { "id": { "description": "The unique identifier of the contact.", "examples": [ "664d0db69fcac7cf2e6ec" ], "example": "664d0db69fcac7cf2e6ec", "type": "string", "pattern": "^(.*)$" }, "externalId": { "anyOf": [ { "type": "string", "description": "A unique identifier from an external system that can optionally be supplied when creating a contact. This ID is used to associate the contact with records in other systems and is required for retrieving the contact later via the \"List Contacts\" endpoint. Ensure the `externalId` is unique and consistent across systems for accurate cross-referencing.", "examples": [ "664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 75, "example": "664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "source": { "anyOf": [ { "type": "string", "description": "Indicates how the contact was created or where it originated from.", "examples": [ "public-api" ], "minLength": 1, "maxLength": 75, "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "type": "string", "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" ], "minLength": 1, "maxLength": 200, "example": "https://openphone.co/contacts/664d0db69fcac7cf2e6ec" }, { "type": "null" } ] }, "defaultFields": { "type": "object", "required": [ "company", "emails", "firstName", "lastName", "phoneNumbers", "role" ], "properties": { "company": { "anyOf": [ { "type": "string", "description": "The contact's company name.", "examples": [ "Quo" ], "example": "Quo" }, { "type": "null" } ] }, "emails": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name for the contact's email address.", "examples": [ "company email" ], "example": "company email" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's email address.", "examples": [ "abc@example.com" ], "example": "abc@example.com" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier for the contact email field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "firstName": { "anyOf": [ { "type": "string", "description": "The contact's first name.", "examples": [ "John" ], "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "type": "string", "description": "The contact's last name.", "examples": [ "Doe" ], "example": "Doe" }, { "type": "null" } ] }, "phoneNumbers": { "type": "array", "items": { "type": "object", "required": [ "name", "value" ], "properties": { "name": { "type": "string", "description": "The name of the contact's phone number.", "examples": [ "company phone" ], "example": "company phone" }, "value": { "anyOf": [ { "type": "string", "description": "The contact's phone number.", "examples": [ "+12345678901" ], "example": "+12345678901" }, { "type": "null" } ] }, "id": { "type": "string", "description": "The unique identifier of the contact phone number field.", "examples": [ "acb123" ], "example": "acb123" } } } }, "role": { "anyOf": [ { "type": "string", "description": "The contact's role.", "examples": [ "Sales" ], "example": "Sales" }, { "type": "null" } ] } } }, "customFields": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "name" ], "properties": { "name": { "type": "string", "description": "The name of the custom contact field. This name is set by users in the Quo interface when the custom field is created.", "examples": [ "Inbound Lead" ], "example": "Inbound Lead" }, "key": { "type": "string", "description": "The identifying key for contact custom field.", "examples": [ "inbound-lead" ], "example": "inbound-lead" } } }, { "anyOf": [ { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "multi-select" ] }, "value": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Value defined for the multi select type custom field.", "examples": [ [ "option1", "option2" ] ], "example": [ "option1", "option2" ] } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "address", "string", "url" ] }, "value": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Value defined for the address, string, or url type custom field.", "examples": [ "123 Main St" ], "example": "123 Main St" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "boolean" ] }, "value": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "description": "Value defined for the boolean type custom field.", "examples": [ "false" ], "example": "false" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "date" ] }, "value": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ], "description": "Value defined for the date type custom fields.", "examples": [ "2024-09-11T04:00:00.000Z" ], "example": "2024-09-11T04:00:00.000Z" } } }, { "type": "object", "required": [ "type", "value" ], "properties": { "type": { "type": "string", "enum": [ "number" ] }, "value": { "anyOf": [ { "type": "number" }, { "type": "null" } ], "description": "Value for the number custom field.", "examples": [ "424242" ], "example": "424242" } } } ] } ] } }, "createdAt": { "description": "Timestamp of contact 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 contact update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, "createdByUserId": { "description": "The unique identifier of the user who created the contact.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } } } }, "400": { "description": "Bad Request | Invalid Custom Field Item", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidCustomFieldItemError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError2" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800404" }, "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" } } } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800409" }, "status": { "type": "number", "const": 409 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError7" }, { "$ref": "#/components/schemas/UnknownError7" } ] } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete a contact", "description": "Delete a contact by its unique identifier.", "operationId": "deleteContact_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "66d0d87e8dc1211467372303" ], "type": "string", "pattern": "^(.*)$" }, "example": "66d0d87e8dc1211467372303" } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request | Invalid Custom Field Item", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError2" }, { "$ref": "#/components/schemas/InvalidCustomFieldItemError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError2" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800404" }, "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" } } } } } } } } } } }, "409": { "description": "Conflict", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800409" }, "status": { "type": "number", "const": 409 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError7" }, { "$ref": "#/components/schemas/UnknownError7" } ] } } } } } } }, "/v1/conversations": { "get": { "tags": [ "Conversations" ], "summary": "List conversations", "description": "Fetch a paginated list of conversations of Quo conversations. Can be filtered by user and/or phone numbers. Defaults to all conversations in the Quo organization. Results are returned in descending order based on the most recent conversation.", "operationId": "listConversations_v1", "parameters": [ { "in": "query", "name": "phoneNumber", "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": "string", "pattern": "^PN(.*)$" } ], "description": "DEPRECATED, use `phoneNumbers` instead. If both `phoneNumber` and `phoneNumbers` are provided, `phoneNumbers` will be used. Filters results to only include conversations with the specified Quo phone number. Can be either your Quo phone number ID or the full phone number in E.164 format.", "examples": [ "+15555555555", "PN123abc" ], "deprecated": true }, "example": "+15555555555" }, { "in": "query", "name": "phoneNumbers", "required": false, "schema": { "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}$" }, { "type": "string", "pattern": "^PN(.*)$" } ] }, "description": "Filters results to only include conversations with the specified Quo phone numbers. Each item can be either an Quo phone number ID or a full phone number in E.164 format.", "examples": [ [ "+15555555555", "PN123abc" ] ], "minItems": 1, "maxItems": 100 }, "example": [ "+15555555555", "PN123abc" ] }, { "in": "query", "name": "userId", "required": false, "schema": { "description": "The unique identifier of the user whose access scope is applied to the results. Scopes the response to conversations accessible to the specified user.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "description": "Filter results to only include conversations created after the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "description": "Filter results to only include conversations created before the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "excludeInactive", "required": false, "schema": { "type": "boolean", "description": "Exclude inactive conversations from the results.", "examples": [ true ] }, "example": true }, { "in": "query", "name": "updatedAfter", "required": false, "schema": { "description": "Filter results to only include conversations updated after the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "updatedBefore", "required": false, "schema": { "description": "Filter results to only include conversations updated before the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "maxResults", "required": true, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 10, "maximum": 100, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems", "nextPageToken" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ], "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "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" } ] } } }, "description": "Array of items" }, "totalItems": { "type": "integer", "description": "Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue." }, "nextPageToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError3" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError3" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError8" }, { "$ref": "#/components/schemas/UnknownError8" } ] } } } } } } }, "/v1/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_v1", "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" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ], "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "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", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError3" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError3" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError8" }, { "$ref": "#/components/schemas/UnknownError8" } ] } } } } } } }, "/v1/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_v1", "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" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ], "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "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", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError3" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError3" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError8" }, { "$ref": "#/components/schemas/UnknownError8" } ] } } } } } } }, "/v1/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_v1", "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" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ], "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc" }, { "type": "null" } ] }, "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", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden | Not Phone Number User", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError3" }, { "$ref": "#/components/schemas/NotPhoneNumberUserError3" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError8" }, { "$ref": "#/components/schemas/UnknownError8" } ] } } } } } } }, "/v1/messages": { "post": { "tags": [ "Messages" ], "summary": "Send a text message", "description": "Send a text message from your Quo number to a recipient.", "operationId": "sendMessage_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "content", "from", "to" ], "properties": { "content": { "type": "string", "minLength": 1, "maxLength": 1600, "pattern": ".*\\S.*", "description": "The text content of the message to be sent." }, "phoneNumberId": { "description": "DEPRECATED, use \"from\" instead. Quo phone number ID to send a message from", "examples": [ "OP1232abc" ], "deprecated": true, "example": "OP1232abc", "type": "string", "pattern": "^PN(.*)$" }, "from": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" } ], "description": "The sender's phone number. Can be either your Quo phone number ID or the full phone number in E.164 format.", "examples": [ "+15555555555" ], "example": "+15555555555" }, "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", "maxLength": 15 } ] }, "minItems": 1, "maxItems": 10, "description": "Array of recipient phone numbers in E.164 format. Currently supports a maximum of 10 recipients", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "userId": { "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.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "setInboxStatus": { "type": "string", "enum": [ "done" ], "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" } } } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "to", "from", "text", "phoneNumberId", "conversationId", "direction", "userId", "status", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "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}$", "example": "+15555555555" }, "description": "Array of recipient phone numbers in E.164 format. Includes your Quo number for incoming messages.", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "from": { "type": "string", "description": "The from identifier, typically a E.164 phone number but can be a variety of formats.", "examples": [ "+15555555555" ], "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 who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message 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 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" }, { "type": "null" } ], "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" } } }, "description": "Media attached to the message." } } } } } } } }, "400": { "description": "Bad Request | User Opted Out | Invalid `to` Phone Number | Unreachable `to` Phone Number | Not TFN Registered | A2P Registration Not Approved", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError3" }, { "$ref": "#/components/schemas/UserOptedOutError" }, { "$ref": "#/components/schemas/InvalidToPhoneNumberError" }, { "$ref": "#/components/schemas/UnreachableToPhoneNumberError" }, { "$ref": "#/components/schemas/NotTFNRegisteredError" }, { "$ref": "#/components/schemas/A2PRegistrationNotApprovedError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Not Enough Credits | Subscription Expired | 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": { "oneOf": [ { "$ref": "#/components/schemas/NotEnoughCreditsError" }, { "$ref": "#/components/schemas/SubscriptionExpiredError" }, { "$ref": "#/components/schemas/TextAllowanceUsedUpTheWorkspaceIsOnAnAgentPlanAndHasNoTextsLeftTheMessageSaysWhichAllowanceIsUsedUpAndHowToGetMoreError" } ] } } } }, "403": { "description": "Forbidden | A2P Daily Message Cap Reached", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError4" }, { "$ref": "#/components/schemas/A2PDailyMessageCapReachedError" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200404" }, "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" } } } } } } } } } } }, "429": { "description": "Too Many Requests. `RATE_LIMIT_EXCEEDED`: the API key sent too many requests per second; retry after a short delay. `0200429`: the organization reached its daily outbound conversation limit.", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200429" }, "status": { "type": "number", "const": 429 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Daily Conversation 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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string" }, "status": { "type": "number", "const": 429 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } ] } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError9" }, { "$ref": "#/components/schemas/UnknownError9" } ] } } } } } }, "get": { "tags": [ "Messages" ], "summary": "List messages", "description": "Retrieve a chronological list of messages exchanged between your Quo number and specified participants, with support for filtering and pagination. ", "operationId": "listMessages_v1", "parameters": [ { "in": "query", "name": "phoneNumberId", "required": true, "schema": { "description": "The unique identifier of the Quo number used to send or receive the messages. PhoneNumberID can be retrieved via the Get Phone Numbers endpoint.", "examples": [ "OP123abc" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "OP123abc" }, { "in": "query", "name": "userId", "required": false, "schema": { "description": "The unique identifier of the user the message was sent from.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" }, { "in": "query", "name": "participants", "required": true, "schema": { "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": "Array of phone numbers involved in the conversation, excluding your Quo number, in E.164 format. Passing a single participant will retrieve their conversation messages. Passing multiple participants will retrieve group conversation messages. Repeat the \"participants\" key for each phone number without brackets, e.g. \"participants=%2B15555555555&participants=%2B15555555556\".", "maxItems": 10, "examples": [ "+15555555555" ] }, "example": "+15555555555" }, { "in": "query", "name": "since", "required": false, "schema": { "deprecated": true, "description": "DEPRECATED, use \"createdAfter\" or \"createdBefore\" instead. \"since\" currently behaves as \"createdBefore\" and will be removed in an upcoming release.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "description": "Filter results to only include messages created after the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "description": "Filter results to only include messages created before the specified date and time, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "type": "string", "format": "date-time" }, "example": "2022-01-01T00:00:00Z" }, { "in": "query", "name": "maxResults", "required": true, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 10, "maximum": 100, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems", "nextPageToken" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "to", "from", "text", "phoneNumberId", "conversationId", "direction", "userId", "status", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "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}$", "example": "+15555555555" }, "description": "Array of recipient phone numbers in E.164 format. Includes your Quo number for incoming messages.", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "from": { "type": "string", "description": "The from identifier, typically a E.164 phone number but can be a variety of formats.", "examples": [ "+15555555555" ], "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 who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message 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 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" }, { "type": "null" } ], "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" } } }, "description": "Media attached to the message." } } }, "description": "Array of items" }, "totalItems": { "type": "integer", "description": "Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue." }, "nextPageToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request | User Opted Out | Invalid `to` Phone Number | Unreachable `to` Phone Number | Not TFN Registered | A2P Registration Not Approved", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError3" }, { "$ref": "#/components/schemas/UserOptedOutError" }, { "$ref": "#/components/schemas/InvalidToPhoneNumberError" }, { "$ref": "#/components/schemas/UnreachableToPhoneNumberError" }, { "$ref": "#/components/schemas/NotTFNRegisteredError" }, { "$ref": "#/components/schemas/A2PRegistrationNotApprovedError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Not Enough Credits | Subscription Expired", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NotEnoughCreditsError" }, { "$ref": "#/components/schemas/SubscriptionExpiredError" } ] } } } }, "403": { "description": "Forbidden | A2P Daily Message Cap Reached", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError5" }, { "$ref": "#/components/schemas/A2PDailyMessageCapReachedError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError9" }, { "$ref": "#/components/schemas/UnknownError9" } ] } } } } } } }, "/v1/messages/{id}": { "get": { "tags": [ "Messages" ], "summary": "Get a message by ID", "description": "Get a message by its unique identifier.", "operationId": "getMessageById_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of a message", "examples": [ "AC123abc" ], "type": "string", "pattern": "^AC(.*)$" }, "example": "AC123abc" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "to", "from", "text", "phoneNumberId", "conversationId", "direction", "userId", "status", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the message.", "examples": [ "AC123abc" ], "example": "AC123abc", "type": "string", "pattern": "^AC(.*)$" }, "to": { "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}$", "example": "+15555555555" }, "description": "Array of recipient phone numbers in E.164 format. Includes your Quo number for incoming messages.", "examples": [ [ "+15555555555" ] ], "example": [ "+15555555555" ] }, "from": { "type": "string", "description": "The from identifier, typically a E.164 phone number but can be a variety of formats.", "examples": [ "+15555555555" ], "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 who sent the message. Null for incoming messages.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "queued", "sent", "delivered", "undelivered", "received" ], "description": "The status of the message.", "examples": [ "sent" ], "example": "sent" }, "createdAt": { "description": "The timestamp when the message 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 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" }, { "type": "null" } ], "description": "The MIME type of the attached media.", "examples": [ "image/png" ], "example": "image/png" } } }, "description": "Media attached to the message." } } } } } } } }, "400": { "description": "Bad Request | User Opted Out | Invalid `to` Phone Number | Unreachable `to` Phone Number | Not TFN Registered | A2P Registration Not Approved", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError3" }, { "$ref": "#/components/schemas/UserOptedOutError" }, { "$ref": "#/components/schemas/InvalidToPhoneNumberError" }, { "$ref": "#/components/schemas/UnreachableToPhoneNumberError" }, { "$ref": "#/components/schemas/NotTFNRegisteredError" }, { "$ref": "#/components/schemas/A2PRegistrationNotApprovedError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Not Enough Credits | Subscription Expired", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/NotEnoughCreditsError" }, { "$ref": "#/components/schemas/SubscriptionExpiredError" } ] } } } }, "403": { "description": "Forbidden | A2P Daily Message Cap Reached", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ForbiddenError5" }, { "$ref": "#/components/schemas/A2PDailyMessageCapReachedError2" } ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError9" }, { "$ref": "#/components/schemas/UnknownError9" } ] } } } } } } }, "/v1/phone-numbers": { "get": { "tags": [ "Phone Numbers" ], "summary": "List phone numbers", "description": "Retrieve the list of phone numbers and users associated with your Quo workspace.", "operationId": "listPhoneNumbers_v1", "parameters": [ { "in": "query", "name": "userId", "required": false, "schema": { "description": "Filter results to return only phone numbers associated with the specified user\"s unique identifier.", "examples": [ "US123abc" ], "type": "string", "pattern": "^US(.*)$" }, "example": "US123abc" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListPhoneNumbersResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError10" }, { "$ref": "#/components/schemas/UnknownError10" } ] } } } } } } }, "/v1/phone-numbers/{phoneNumberId}": { "get": { "tags": [ "Phone Numbers" ], "summary": "Get a phone number by ID", "description": "Get a phone number by its unique identifier.", "operationId": "getPhoneNumberById_v1", "parameters": [ { "in": "path", "name": "phoneNumberId", "required": true, "schema": { "description": "Unique identifier of the phone number.", "examples": [ "PNlja6rrtI" ], "type": "string", "pattern": "^PN(.*)$" }, "example": "PNlja6rrtI" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "groupId", "portRequestId", "formattedNumber", "forward", "name", "number", "portingStatus", "symbol", "users", "createdAt", "updatedAt", "restrictions" ], "properties": { "id": { "description": "The unique identifier of Quo phone number.", "examples": [ "PN123bc" ], "example": "PN123bc", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "type": "string", "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "1234" ], "example": "1234" }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of a phone number.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "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" } ] }, "name": { "type": "string", "description": "The display name of the phone number", "examples": [ "My phone number" ], "example": "My phone number" }, "number": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "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" } ] }, "users": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id", "email", "firstName", "lastName", "role" ], "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" } } }, { "type": "object", "required": [ "groupId" ], "properties": { "groupId": { "description": "The unique identifier of the group to which the user belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" } } } ], "type": "object" } }, "createdAt": { "type": "string", "description": "Timestamp of when the phone number was added to the account in ISO 8601 format.", "examples": [ " '2022-01-01T00:00:00Z'" ], "example": " '2022-01-01T00:00:00Z'" }, "updatedAt": { "type": "string", "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'" }, "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" } } } } } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError10" }, { "$ref": "#/components/schemas/UnknownError10" } ] } } } } } } }, "/v1/tasks": { "get": { "tags": [ "Tasks" ], "summary": "List tasks", "description": "Retrieve a list of tasks", "operationId": "listTasks_v1", "parameters": [ { "in": "query", "name": "maxResults", "required": true, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 50, "maximum": 100, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "taskId", "phoneNumberId", "conversationId", "activityId", "phoneNumberGroupId", "orgId", "title", "description", "dueDate", "assignedTo", "assignedBy", "createdAt", "createdBy", "completed", "completedAt", "isDeleted", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "phoneNumberId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "anyOf": [ { "type": "string", "pattern": "^CN(.*)$" }, { "type": "null" } ] }, "activityId": { "anyOf": [ { "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "phoneNumberGroupId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "orgId": { "type": "string", "pattern": "^OR(.*)$" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "assignedBy": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "completed": { "type": "boolean" }, "completedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "revision": { "type": "string" } } }, "description": "Array of items" }, "nextPageToken": { "type": "string" }, "totalItems": { "type": "integer", "description": "Total number of items available." } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } }, "post": { "tags": [ "Tasks" ], "summary": "Create a task", "description": "Create a task, optionally linked to a phone number, conversation, or conversation activity. Provide at most one of `phoneNumberId`, `conversationId`, or `activityId`; omit all three to create an org-wide task visible to every member of the organization.", "operationId": "createTask_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "title", "description", "phoneNumberId" ], "properties": { "title": { "type": "string", "description": "The title of the task.", "examples": [ "Follow up with customer" ], "example": "Follow up with customer" }, "description": { "type": "string", "description": "The description of the task.", "examples": [ "Discuss pricing and onboarding next steps." ], "example": "Discuss pricing and onboarding next steps." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "type": "string", "pattern": "^US(.*)$" }, "phoneNumberId": { "type": "string", "pattern": "^PN(.*)$" } }, "additionalProperties": false, "title": "Linked to a phone number" }, { "type": "object", "required": [ "title", "description", "conversationId" ], "properties": { "title": { "type": "string", "description": "The title of the task.", "examples": [ "Follow up with customer" ], "example": "Follow up with customer" }, "description": { "type": "string", "description": "The description of the task.", "examples": [ "Discuss pricing and onboarding next steps." ], "example": "Discuss pricing and onboarding next steps." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "type": "string", "pattern": "^US(.*)$" }, "conversationId": { "type": "string", "pattern": "^CN(.*)$" } }, "additionalProperties": false, "title": "Linked to a conversation" }, { "type": "object", "required": [ "title", "description", "activityId" ], "properties": { "title": { "type": "string", "description": "The title of the task.", "examples": [ "Follow up with customer" ], "example": "Follow up with customer" }, "description": { "type": "string", "description": "The description of the task.", "examples": [ "Discuss pricing and onboarding next steps." ], "example": "Discuss pricing and onboarding next steps." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "type": "string", "pattern": "^US(.*)$" }, "activityId": { "type": "string", "pattern": "^AC(.*)$" } }, "additionalProperties": false, "title": "Linked to an activity" }, { "type": "object", "required": [ "title", "description" ], "properties": { "title": { "type": "string", "description": "The title of the task.", "examples": [ "Follow up with customer" ], "example": "Follow up with customer" }, "description": { "type": "string", "description": "The description of the task.", "examples": [ "Discuss pricing and onboarding next steps." ], "example": "Discuss pricing and onboarding next steps." }, "dueDate": { "type": "string", "format": "date-time" }, "assignedTo": { "type": "string", "pattern": "^US(.*)$" } }, "additionalProperties": false, "title": "Org-wide task" } ], "description": "The task to create. Provide at most one of `phoneNumberId`, `conversationId`, or `activityId` to link the task to that resource. Omit all three to create an org-wide task." } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" }, "phoneNumberId": { "type": "string", "pattern": "^PN(.*)$" }, "conversationId": { "type": "string", "pattern": "^CN(.*)$" }, "activityId": { "type": "string", "pattern": "^AC(.*)$" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}": { "get": { "tags": [ "Tasks" ], "summary": "Gets a task by ID", "description": "Retrieve a single task by its ID", "operationId": "getTaskById_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "phoneNumberId", "conversationId", "activityId", "phoneNumberGroupId", "orgId", "title", "description", "dueDate", "assignedTo", "assignedBy", "createdAt", "createdBy", "completed", "completedAt", "isDeleted", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "phoneNumberId": { "anyOf": [ { "type": "string", "pattern": "^PN(.*)$" }, { "type": "null" } ] }, "conversationId": { "anyOf": [ { "type": "string", "pattern": "^CN(.*)$" }, { "type": "null" } ] }, "activityId": { "anyOf": [ { "type": "string", "pattern": "^AC(.*)$" }, { "type": "null" } ] }, "phoneNumberGroupId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "orgId": { "type": "string", "pattern": "^OR(.*)$" }, "title": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dueDate": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "assignedTo": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "assignedBy": { "anyOf": [ { "anyOf": [ { "type": "string", "pattern": "^US(.*)$" }, { "type": "string", "pattern": "^SYU(.*)$" } ] }, { "type": "null" } ] }, "createdAt": { "type": "string", "format": "date-time" }, "createdBy": { "type": "string" }, "completed": { "type": "boolean" }, "completedAt": { "anyOf": [ { "type": "string", "format": "date-time" }, { "type": "null" } ] }, "isDeleted": { "type": "boolean" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } }, "delete": { "tags": [ "Tasks" ], "summary": "Delete a task by ID", "description": "Deletes the task with the provided task ID", "operationId": "deleteTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } }, "put": { "tags": [ "Tasks" ], "summary": "Update a task", "description": "Updates the task's title and description", "operationId": "updateTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "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": [ "Follow up with customer" ], "example": "Follow up with customer" }, "description": { "type": "string", "description": "The description of the task.", "examples": [ "Discuss pricing and onboarding next steps." ], "example": "Discuss pricing and onboarding next steps." } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/complete": { "post": { "tags": [ "Tasks" ], "summary": "Complete a task", "description": "Marks the provided task as completed", "operationId": "completeTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/link-conversation": { "post": { "tags": [ "Tasks" ], "summary": "Link a task to a conversation", "description": "Links the task with the provided task ID to a conversation", "operationId": "linkTaskToConversation_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "conversationId" ], "properties": { "conversationId": { "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": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/unlink-conversation": { "post": { "tags": [ "Tasks" ], "summary": "Unlink a task from a conversation", "description": "Unlinks the provided conversation from the task", "operationId": "unlinkTaskFromConversation_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "conversationId" ], "properties": { "conversationId": { "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": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/reopen": { "post": { "tags": [ "Tasks" ], "summary": "Reopen a task", "description": "Reopens the provided task", "operationId": "reopenTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/assign": { "post": { "tags": [ "Tasks" ], "summary": "Assign a user to a task", "description": "Assigns the provided user to the list of assignees for the task", "operationId": "assignTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "pattern": "^US(.*)$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/unassign": { "post": { "tags": [ "Tasks" ], "summary": "Unassign a user from a task", "description": "Removes the provided user from the assignee list of a task", "operationId": "unassignTask_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "userId" ], "properties": { "userId": { "type": "string", "pattern": "^US(.*)$" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/change-due-date": { "post": { "tags": [ "Tasks" ], "summary": "Change a task's due date", "description": "Sets the task's due date", "operationId": "changeTaskDueDate_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "dueDate" ], "properties": { "dueDate": { "type": "string", "format": "date-time" } }, "additionalProperties": false } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/tasks/{taskId}/remove-due-date": { "post": { "tags": [ "Tasks" ], "summary": "Remove a task's due date", "description": "Clears the task's due date", "operationId": "removeTaskDueDate_v1", "parameters": [ { "in": "path", "name": "taskId", "required": true, "schema": { "type": "string", "pattern": "^TK(.*)$" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "taskId", "revision" ], "properties": { "taskId": { "type": "string", "pattern": "^TK(.*)$" }, "revision": { "type": "string" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600401" }, "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" } } } } } } } } ] } } } }, "402": { "description": "Open Tasks Limit Reached", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError4" }, { "$ref": "#/components/schemas/UnknownError11" } ] } } } } } } }, "/v1/users": { "get": { "tags": [ "Users" ], "summary": "List users", "description": "Retrieve a paginated list of users in your Quo workspace.", "operationId": "listUsers_v1", "parameters": [ { "in": "query", "name": "maxResults", "required": false, "schema": { "type": "integer", "description": "Maximum number of results to return per page.", "default": 10, "maximum": 50, "minimum": 1 } }, { "in": "query", "name": "pageToken", "required": false, "schema": { "type": "string" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "totalItems", "nextPageToken" ], "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" } } }, "description": "Array of items" }, "totalItems": { "type": "integer", "description": "Total number of items available. ⚠️ Note: `totalItems` is not accurately returning the total number of items that can be paginated. We are working on fixing this issue." }, "nextPageToken": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError11" }, { "$ref": "#/components/schemas/UnknownError12" } ] } } } } } } }, "/v1/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_v1", "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" } ], "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", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100400" }, "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" } } } } } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100401" }, "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" } } } } } } } } ] } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100403" }, "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" } } } } } } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100404" }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError11" }, { "$ref": "#/components/schemas/UnknownError12" } ] } } } } } } }, "/v1/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Lists all webhooks", "description": "List all webhooks for a user.", "operationId": "listWebhooks_v1", "parameters": [ { "in": "query", "name": "userId", "required": false, "schema": { "description": "The unique identifier the user. Defaults to the workspace owner.", "examples": [ "U55wgP5I5" ], "type": "string", "pattern": "^US(.*)$" }, "example": "U55wgP5I5" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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": [ "*" ] } } } ] } } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } }, "/v1/webhooks/{id}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a webhook by ID", "description": "Get a webhook by its unique identifier.", "operationId": "getWebhookById_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "WH12345" ], "type": "string", "pattern": "^WH(.*)$" }, "example": "WH12345" } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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": [ "*" ] } } } ] } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a webhook by ID", "description": "Delete a webhook by its unique identifier.", "operationId": "deleteWebhookById_v1", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "WH12345" ], "type": "string", "pattern": "^WH(.*)$" }, "example": "WH12345" } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content" }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } }, "/v1/webhooks/messages": { "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook for messages", "description": "Creates a new webhook that triggers on events from messages.", "operationId": "createMessageWebhook_v1", "parameters": [], "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" ] }, "description": "An event associated with the webhook.", "examples": [ [ "message.received" ] ], "example": [ "message.received" ] }, "label": { "type": "string", "description": "Webhook's label", "examples": [ "my webhook label" ], "example": "my webhook label" }, "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" ] }, "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" }, "userId": { "description": "The unique identifier of the user that creates the webhook. If not provided, default to workspace owner.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] }, "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" ] } } } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } }, "/v1/webhooks/calls": { "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook for calls", "description": "Creates a new webhook that triggers on events from calls.", "operationId": "createCallWebhook_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "url", "events" ], "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": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "description": "An event associated with the webhook.", "examples": [ [ "call.completed" ] ], "example": [ "call.completed" ] }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ "PN1234" ], "example": "PN1234", "anyOf": [ { "type": "array", "items": { "type": "string", "pattern": "^PN(.*)$" } }, { "type": "array", "items": { "type": "string", "const": "*" } } ] }, "userId": { "description": "The unique identifier of the user that creates the webhook. If not provided, default to workspace owner.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "label": { "type": "string", "description": "Webhook's label", "examples": [ "my webhook label" ], "example": "my webhook label" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "events": { "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] }, "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" ] } } } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } }, "/v1/webhooks/call-summaries": { "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook for call summaries", "description": "Creates a new webhook that triggers on events from call summaries.", "operationId": "createCallSummaryWebhook_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events", "url" ], "properties": { "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" ] }, "label": { "type": "string", "description": "Webhook's label", "examples": [ "my webhook label" ], "example": "my webhook label" }, "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" ] }, "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" }, "userId": { "description": "The unique identifier of the user that creates the webhook. If not provided, default to workspace owner.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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" ] } } } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } }, "/v1/webhooks/call-transcripts": { "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook for call transcripts", "description": "Creates a new webhook that triggers on events from call transcripts.", "operationId": "createCallTranscriptWebhook_v1", "parameters": [], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events", "url" ], "properties": { "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" ] }, "label": { "type": "string", "description": "The webhook's label.", "examples": [ "my webhook label" ], "example": "my webhook label" }, "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" }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "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" }, "userId": { "description": "The ID of the user that creates the webhook. If not provided, default to workspace owner.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "userId", "orgId", "label", "status", "url", "key", "createdAt", "updatedAt", "deletedAt", "events", "resourceIds" ], "properties": { "id": { "description": "The webhook's ID", "examples": [ "WHabcd1234" ], "example": "WHabcd1234", "type": "string", "pattern": "^WH(.*)$" }, "userId": { "description": "The unique identifier of the user that created the webhook.", "examples": [ "US123abc" ], "example": "US123abc", "type": "string", "pattern": "^US(.*)$" }, "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/" }, "key": { "type": "string", "description": "Webhook key", "examples": [ "example-key" ], "example": "example-key" }, "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" }, "deletedAt": { "anyOf": [ { "description": "The date the webhook was deleted at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "example": "2022-01-01T00:00:00Z", "type": "string", "format": "date-time" }, { "type": "null" } ] }, "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" ] } } } } } } } }, "400": { "description": "Bad Request | Invalid Resource Id Type | Input Too Long | Invalid Id | Invalid Input Format | Invalid Version", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/BadRequestError4" }, { "$ref": "#/components/schemas/InvalidResourceIdTypeError" }, { "$ref": "#/components/schemas/InputTooLongError" }, { "$ref": "#/components/schemas/InvalidIdError" }, { "$ref": "#/components/schemas/InvalidInputFormatError" }, { "$ref": "#/components/schemas/InvalidVersionError" } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "message", "key" ], "properties": { "message": { "type": "string" }, "key": { "type": "string", "const": "Unauthorized" }, "trace": { "type": "string" } } } } }, { "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" } } } } } } } } ] } } } }, "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" } } } } } } } } } } }, "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" } } } } } } } } } } }, "500": { "description": "Unexpected Error | Unknown Error", "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/UnexpectedError12" }, { "$ref": "#/components/schemas/UnknownError13" } ] } } } } } } } }, "components": { "schemas": { "ListPhoneNumbersResponse": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "groupId", "portRequestId", "formattedNumber", "forward", "name", "number", "portingStatus", "symbol", "users", "createdAt", "updatedAt", "restrictions" ], "properties": { "id": { "description": "The unique identifier of Quo phone number.", "examples": [ "PN123bc" ], "example": "PN123bc", "type": "string", "pattern": "^PN(.*)$" }, "groupId": { "type": "string", "description": "The unique identifier of the group to which the Quo number belongs.", "examples": [ "1234" ], "example": "1234" }, "portRequestId": { "anyOf": [ { "type": "string", "description": "Unique identifier for the phone number’s porting request, if applicable.", "examples": [ "123abc" ], "example": "123abc" }, { "type": "null" } ] }, "formattedNumber": { "anyOf": [ { "type": "string", "description": "A human-readable representation of a phone number.", "examples": [ "+15555555555" ], "example": "+15555555555" }, { "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" } ] }, "name": { "type": "string", "description": "The display name of the phone number", "examples": [ "My phone number" ], "example": "My phone number" }, "number": { "type": "string", "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "example": "+15555555555" }, "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" } ] }, "users": { "type": "array", "items": { "allOf": [ { "type": "object", "required": [ "id", "email", "firstName", "lastName", "role" ], "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" } } }, { "type": "object", "required": [ "groupId" ], "properties": { "groupId": { "description": "The unique identifier of the group to which the user belongs.", "examples": [ "GRcei8k90o" ], "example": "GRcei8k90o", "type": "string", "pattern": "^GR(.*)$" } } } ], "type": "object" } }, "createdAt": { "type": "string", "description": "Timestamp of when the phone number was added to the account in ISO 8601 format.", "examples": [ " '2022-01-01T00:00:00Z'" ], "example": " '2022-01-01T00:00:00Z'" }, "updatedAt": { "type": "string", "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'" }, "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" } } } } } } } } } }, "UnexpectedError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0900500" }, "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" }, "UnknownError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0901500" }, "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" }, "BadRequestError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100400" }, "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" }, "TooManyParticipantsError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0101400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Too Many Participants" }, "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": "Too Many Participants" }, "ForbiddenError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100403" }, "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" } } } } } } }, "title": "Forbidden" }, "NotPhoneNumberUserError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0101403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Not Phone Number User" }, "UnexpectedError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0100500" }, "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": "0101500" }, "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" }, "UnexpectedError3": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0500500" }, "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" }, "UnknownError3": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0501500" }, "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" }, "UnexpectedError4": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0600500" }, "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" }, "UnknownError4": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0601500" }, "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" }, "UnexpectedError5": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1200500" }, "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" }, "UnknownError5": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1201500" }, "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" }, "UnexpectedError6": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0700500" }, "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" }, "UnknownError6": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0701500" }, "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" }, "BadRequestError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800400" }, "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" }, "InvalidCustomFieldItemError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0801400" }, "status": { "type": "number", "const": 400 }, "docs": { "type": "string", "const": "https://quo.com/docs" }, "title": { "type": "string", "const": "Invalid Custom Field Item" }, "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": "Invalid Custom Field Item" }, "ForbiddenError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800403" }, "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" } } } } } } }, "title": "Forbidden" }, "NotPhoneNumberUserError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0801403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Not Phone Number User" } }, "title": "Not Phone Number User" }, "UnexpectedError7": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0800500" }, "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" }, "UnknownError7": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0801500" }, "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" }, "ForbiddenError3": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000403" }, "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" } } } } } } }, "title": "Forbidden" }, "NotPhoneNumberUserError3": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1001403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Not Phone Number User" }, "UnexpectedError8": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1000500" }, "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" }, "UnknownError8": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1001500" }, "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" }, "BadRequestError3": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200400" }, "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" }, "UserOptedOutError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0201400" }, "status": { "type": "number", "const": 400 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "User Opted Out" }, "InvalidToPhoneNumberError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0202400" }, "status": { "type": "number", "const": 400 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Invalid `to` Phone Number" }, "UnreachableToPhoneNumberError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0203400" }, "status": { "type": "number", "const": 400 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Unreachable `to` Phone Number" }, "NotTFNRegisteredError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0207400" }, "status": { "type": "number", "const": 400 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Not TFN Registered" }, "A2PRegistrationNotApprovedError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0206400" }, "status": { "type": "number", "const": 400 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "A2P Registration Not Approved" }, "NotEnoughCreditsError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "Not Enough Credits" }, "SubscriptionExpiredError": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0201402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } }, "description": { "type": "string", "const": "Your subscription has expired" } }, "title": "Subscription Expired" }, "TextAllowanceUsedUpTheWorkspaceIsOnAnAgentPlanAndHasNoTextsLeftTheMessageSaysWhichAllowanceIsUsedUpAndHowToGetMoreError": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0202402" }, "status": { "type": "number", "const": 402 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "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." }, "ForbiddenError4": { "anyOf": [ { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200403" }, "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" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0202403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0203403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } ], "title": "Forbidden" }, "A2PDailyMessageCapReachedError": { "anyOf": [ { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200403" }, "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" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0202403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0203403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } ], "title": "A2P Daily Message Cap Reached" }, "UnexpectedError9": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200500" }, "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" }, "UnknownError9": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0201500" }, "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" }, "ForbiddenError5": { "anyOf": [ { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0200403" }, "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" } } } } } } } }, { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0202403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } } ], "title": "Forbidden" }, "A2PDailyMessageCapReachedError2": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0204403" }, "status": { "type": "number", "const": 403 }, "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", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } }, "title": "A2P Daily Message Cap Reached" }, "UnexpectedError10": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0400500" }, "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" }, "UnknownError10": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0401500" }, "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" }, "UnknownError11": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "0601500" }, "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" }, "UnexpectedError11": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1100500" }, "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" }, "UnknownError12": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "type": "string", "const": "1101500" }, "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" }, "BadRequestError4": { "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" }, "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" }, "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" }, "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" }, "UnexpectedError12": { "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" }, "UnknownError13": { "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" } }, "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": [] } ] }