{ "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": { "/contacts": { "get": { "tags": [ "Contacts" ], "summary": "List contacts", "description": "Get a paginated list of contacts.", "operationId": "listContacts", "parameters": [ { "in": "query", "name": "externalIds", "required": false, "schema": { "anyOf": [ { "description": "Filter by external IDs", "maxItems": 50, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, { "in": "query", "name": "sources", "required": false, "schema": { "anyOf": [ { "description": "Filter by source labels", "maxItems": 50, "type": "array", "items": { "type": "string" } }, { "type": "null" } ] } }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "minimum": 1, "maximum": 50, "default": 10, "description": "Page size", "type": "integer" }, { "type": "null" } ] } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "type": "string" }, { "type": "null" } ] } }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string", "example": "6a145ff26212a192852c856e" }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "1234567890" ], "type": "string", "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "public-api" ], "type": "string", "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "type": "string", "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "description": "The first name of the contact.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Quo" ], "type": "string", "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "admin" ], "type": "string", "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] } } } }, "nextCursor": { "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Create a contact", "description": "Create a new contact in the organization.", "operationId": "createContact", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "firstName" ], "properties": { "firstName": { "description": "The first name of the contact.", "examples": [ "Alice" ], "type": "string", "example": "Alice" }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Johnson" ], "type": "string", "example": "Johnson" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Acme Corp" ], "type": "string", "example": "Acme Corp" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "CEO" ], "type": "string", "example": "CEO" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "external-001" ], "type": "string", "example": "external-001" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "external" ], "type": "string", "example": "external" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "type": "string", "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "actorId": { "anyOf": [ { "description": "The actor ID to attribute contact creation to. Defaults to the organization owner.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string", "example": "US123abc" }, { "type": "null" } ] } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string", "example": "6a145ff26212a192852c856e" }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "1234567890" ], "type": "string", "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "public-api" ], "type": "string", "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "type": "string", "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "description": "The first name of the contact.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Quo" ], "type": "string", "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "admin" ], "type": "string", "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } }, "/contacts/{contactId}": { "get": { "tags": [ "Contacts" ], "summary": "Get a contact by ID", "description": "Retrieve detailed information about a specific contact in your Quo workspace using the contact's unique identifier.", "operationId": "getContactById", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact being retrieved.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string", "example": "6a145ff26212a192852c856e" }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "1234567890" ], "type": "string", "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "public-api" ], "type": "string", "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "type": "string", "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "description": "The first name of the contact.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Quo" ], "type": "string", "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "admin" ], "type": "string", "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Update a contact by ID", "description": "Update a contact by ID.", "operationId": "updateContactById", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact being updated.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string" }, "example": "6a145ff26212a192852c856e" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "firstName": { "anyOf": [ { "description": "The first name of the contact.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Quo" ], "type": "string", "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "admin" ], "type": "string", "example": "admin" }, { "type": "null" } ] }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "1234567890" ], "type": "string", "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "public-api" ], "type": "string", "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "The source URL of the contact.", "examples": [ "https://my.quo.com/contacts/6a145ff26212a192852c856e" ], "type": "string", "example": "https://my.quo.com/contacts/6a145ff26212a192852c856e" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "createdAt", "updatedAt", "actorId" ], "properties": { "id": { "description": "The ID of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string", "example": "6a145ff26212a192852c856e" }, "externalId": { "anyOf": [ { "description": "The external ID of the contact.", "examples": [ "1234567890" ], "type": "string", "example": "1234567890" }, { "type": "null" } ] }, "source": { "anyOf": [ { "description": "The source of the contact.", "examples": [ "public-api" ], "type": "string", "example": "public-api" }, { "type": "null" } ] }, "sourceUrl": { "anyOf": [ { "description": "A link to the contact in the source system.", "format": "uri", "examples": [ "https://example.com/contacts/001" ], "minLength": 1, "maxLength": 200, "type": "string", "example": "https://example.com/contacts/001" }, { "type": "null" } ] }, "firstName": { "anyOf": [ { "description": "The first name of the contact.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The last name of the contact.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "company": { "anyOf": [ { "description": "The company of the contact.", "examples": [ "Quo" ], "type": "string", "example": "Quo" }, { "type": "null" } ] }, "role": { "anyOf": [ { "description": "The role of the contact.", "examples": [ "admin" ], "type": "string", "example": "admin" }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact creation.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "description": "The timestamp of the contact update.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "actorId": { "description": "The actor ID of the contact.", "examples": [ "US123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } }, "/contacts/{contactId}/properties": { "get": { "tags": [ "Contact Properties" ], "summary": "List contact properties", "description": "Get a paginated list of properties for a contact.", "operationId": "listContactProperties", "parameters": [ { "in": "path", "name": "contactId", "required": true, "schema": { "description": "The unique identifier of the contact.", "examples": [ "6a145ff26212a192852c856e" ], "pattern": "^(.*)$", "type": "string" }, "example": "6a145ff26212a192852c856e" }, { "in": "query", "name": "limit", "required": false, "schema": { "anyOf": [ { "minimum": 1, "maximum": 50, "default": 10, "description": "Page size", "type": "integer" }, { "type": "null" } ] } }, { "in": "query", "name": "after", "required": false, "schema": { "anyOf": [ { "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "type": "string" }, { "type": "null" } ] } }, { "in": "query", "name": "type", "required": false, "schema": { "anyOf": [ { "description": "Filter properties by type.", "examples": [ "phone-number", "email" ], "type": "string" }, { "type": "null" } ] } }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "type", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the contact property.", "examples": [ "690cba5d99c5f41e1fa7aca3" ], "pattern": "^(.*)$", "type": "string", "example": "690cba5d99c5f41e1fa7aca3" }, "type": { "description": "The type of the contact property.", "examples": [ "phone-number", "email" ], "type": "string", "example": "phone-number" }, "name": { "anyOf": [ { "description": "The label for the contact property.", "examples": [ "Mobile" ], "type": "string", "example": "Mobile" }, { "type": "null" } ] }, "value": { "anyOf": [ { "description": "The value of the contact property.", "examples": [ "+1234567890" ], "example": "+1234567890", "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" }, { "type": "array", "items": { "type": "string" } }, { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, { "type": "object", "patternProperties": { "^(.*)$": {} } } ] }, { "type": "null" } ] }, "createdAt": { "description": "The timestamp of the contact property creation.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" }, "updatedAt": { "description": "The timestamp of the contact property update.", "examples": [ "2021-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2021-01-01T00:00:00Z" } } } }, "nextCursor": { "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "trace": "6897907457496870895" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is unauthorized to perform this action", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The contact was not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error has occurred", "docs": "https://quo.com/docs", "title": "Unknown Error", "trace": "6897907457496870895" } } } } } } }, "/conversations/{conversationId}/mark-as-read": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as read", "description": "Mark a conversation as read, clearing its unread indicator without sending a message. Returns the updated conversation.", "operationId": "markConversationAsRead", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as read.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/conversations/{conversationId}/mark-as-done": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as done", "description": "Mark a conversation as done, removing it from the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsDone", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as done.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/conversations/{conversationId}/mark-as-open": { "post": { "tags": [ "Conversations" ], "summary": "Mark conversation as open", "description": "Mark a conversation as open, returning it to the inbox without sending a message. Returns the updated conversation.", "operationId": "markConversationAsOpen", "parameters": [ { "in": "path", "name": "conversationId", "required": true, "schema": { "description": "The unique identifier of the conversation to mark as open.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string" }, "example": "CN123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "assignedTo", "createdAt", "deletedAt", "id", "lastActivityAt", "lastActivityId", "mutedUntil", "name", "participants", "phoneNumberId", "snoozedUntil", "updatedAt" ], "properties": { "assignedTo": { "anyOf": [ { "description": "The unique identifier of the user or system user the conversation is assigned to.", "examples": [ "US123abc", "SYU123abc" ], "example": "US123abc", "anyOf": [ { "pattern": "^US(.*)$", "type": "string" }, { "pattern": "^SYU(.*)$", "type": "string" } ] }, { "type": "null" } ] }, "createdAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "deletedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "id": { "description": "The unique identifier of the conversation.", "examples": [ "CN123abc" ], "pattern": "^CN(.*)$", "type": "string", "example": "CN123abc" }, "lastActivityAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "lastActivityId": { "anyOf": [ { "description": "The unique identifier of the most recent activity in the conversation.", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string", "example": "AC123abc" }, { "type": "null" } ] }, "mutedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "name": { "anyOf": [ { "description": "The custom name of the conversation. Will be null if no custom name is set.", "examples": [ "Chat with customer" ], "type": "string", "example": "Chat with customer" }, { "type": "null" } ] }, "participants": { "type": "array", "items": { "description": "A phone number in E.164 format, including the country code.", "examples": [ "+15555555555" ], "pattern": "^\\+[1-9]\\d{1,14}$", "type": "string", "example": "+15555555555" } }, "phoneNumberId": { "description": "The unique identifier of the Quo phone number associated with the conversation.", "examples": [ "PN123abc" ], "pattern": "^PN(.*)$", "type": "string", "example": "PN123abc" }, "snoozedUntil": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] }, "updatedAt": { "anyOf": [ { "format": "date-time", "type": "string" }, { "type": "null" } ] } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/conversationId", "message": "Expected string to match '^CN(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^CN(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Conversation not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/messages/{messageId}/retry": { "post": { "tags": [ "Messages" ], "summary": "Retry a failed message", "description": "Attempt to re-deliver a message that previously failed to send. Only messages with a `failed` status can be retried. Messages that have permanently failed (a `failed` status with an error code) and messages with an `undelivered` status cannot be retried.", "operationId": "retryMessage", "parameters": [ { "in": "path", "name": "messageId", "required": true, "schema": { "description": "The unique identifier of the message to retry", "examples": [ "AC123abc" ], "pattern": "^AC(.*)$", "type": "string" }, "example": "AC123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/messageId", "message": "Expected string to match '^AC(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^AC(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The user is forbidden from accessing the message", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Message not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unprocessable Entity", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The message has permanently failed and cannot be retried", "docs": "https://quo.com/docs", "title": "Unprocessable Entity", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/users": { "get": { "tags": [ "Users" ], "summary": "List users", "description": "Retrieve a paginated list of users in your Quo workspace.", "operationId": "listUsers", "parameters": [ { "in": "query", "name": "limit", "required": false, "schema": { "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "type": "string" }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string", "example": "US123abc" }, "email": { "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "type": "string", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "description": "The user's first name.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The user's last name.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "type": "string", "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" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" } } } }, "nextCursor": { "description": "Cursor for the next page, or null when there are no more pages.", "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0", "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/users/{userId}": { "get": { "tags": [ "Users" ], "summary": "Get a user by ID", "description": "Retrieve detailed information about a specific user in your Quo workspace using the user's unique identifier.", "operationId": "getUserById", "parameters": [ { "in": "path", "name": "userId", "required": true, "schema": { "description": "The unique identifier of the user being retrieved.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string" }, "example": "US123abc" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "email", "firstName", "lastName", "pictureUrl", "role", "createdAt", "updatedAt" ], "properties": { "id": { "description": "The unique identifier of the user.", "examples": [ "US123abc" ], "pattern": "^US(.*)$", "type": "string", "example": "US123abc" }, "email": { "description": "The user's email address.", "examples": [ "johndoe@example.com" ], "format": "email", "type": "string", "example": "johndoe@example.com" }, "firstName": { "anyOf": [ { "description": "The user's first name.", "examples": [ "John" ], "type": "string", "example": "John" }, { "type": "null" } ] }, "lastName": { "anyOf": [ { "description": "The user's last name.", "examples": [ "Doe" ], "type": "string", "example": "Doe" }, { "type": "null" } ] }, "pictureUrl": { "anyOf": [ { "description": "The user's picture URL.", "examples": [ "https://example.com/picture.jpg" ], "format": "uri", "type": "string", "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" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "Timestamp of last user update in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "The input was invalid", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/userId", "message": "Expected string to match '^US(.*)$'", "value": "abc123", "schema": { "type": "TemplateLiteral", "pattern": "^US(.*)$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Unauthorized", "docs": "https://quo.com/docs", "title": "Unauthorized", "trace": "6897907457496870895" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User is forbidden to perform this action", "docs": "https://quo.com/docs", "title": "Forbidden", "trace": "6897907457496870895" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "User with ID US1234567890 not found", "docs": "https://quo.com/docs", "title": "Not Found", "trace": "6897907457496870895" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "docs", "title" ], "properties": { "message": { "type": "string" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "We have encountered an unknown error", "docs": "https://quo.com/docs", "title": "Unknown", "trace": "6897907457496870895" } } } } } } }, "/webhooks": { "get": { "tags": [ "Webhooks" ], "summary": "Lists all webhooks", "description": "List all webhooks for an organization.", "operationId": "listHeaderVersionedWebhooks", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "array", "items": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] } }, "resourceIds": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "resourceIds": { "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] } } } ] } } } } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } }, "post": { "tags": [ "Webhooks" ], "summary": "Create a new webhook", "description": "Creates a versioned webhook through the unified endpoint when using the API version header.", "operationId": "createHeaderVersionedWebhook", "parameters": [ { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "events", "url" ], "properties": { "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "url": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/webhook" ], "type": "string", "example": "https://example.com/webhook" }, "resourceIds": { "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Omitting this field defaults to `[\"*\"]`. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ], "anyOf": [ { "minItems": 1, "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "default": "enabled", "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "label": { "description": "The webhook's label.", "examples": [ "my webhook" ], "type": "string", "example": "my webhook" } } } } } }, "responses": { "201": { "description": "Created", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds", "key" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "resourceIds": { "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] }, "key": { "description": "The webhook signing secret used to validate webhook signatures.", "examples": [ "whsec_exampleSecret" ], "type": "string", "example": "whsec_exampleSecret" } } } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "/url: Expected required property, /url: Expected string", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/url", "message": "Expected required property", "schema": { "type": "String" } }, { "path": "/url", "message": "Expected string", "schema": { "type": "String" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}": { "get": { "tags": [ "Webhooks" ], "summary": "Get a webhook by ID", "description": "Get a webhook by its unique identifier.", "operationId": "getHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] } }, "resourceIds": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "resourceIds": { "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] } } } ] } } } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } }, "patch": { "tags": [ "Webhooks" ], "summary": "Update a webhook by ID", "description": "Partially update an existing webhook. Only the fields provided in the request body will be updated.", "operationId": "updateHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "minProperties": 1, "type": "object", "properties": { "url": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook. Pass null, [], or [\"*\"] to clear phone number filtering.", "examples": [ [ "PN1234" ], null, [] ], "example": [ "PN1234" ], "anyOf": [ { "type": "null" }, { "maxItems": 0, "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] }, "status": { "type": "string", "enum": [ "enabled", "disabled" ], "description": "The status of the webhook.", "examples": [ "enabled" ], "example": "enabled" }, "label": { "anyOf": [ { "description": "Webhook's label", "type": "string" }, { "type": "null" } ] } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "anyOf": [ { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "message.received", "message.delivered" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.completed", "call.ringing", "call.recording.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.summary.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.transcript.completed" ] } }, "resourceIds": { "description": "The unique identifiers of the phone numbers associated with the webhook.", "examples": [ [ "PN1234" ] ], "example": [ "PN1234" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "type": "array", "items": { "const": "*", "type": "string" } } ] } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "contact.updated", "contact.deleted" ] } }, "resourceIds": { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } } }, { "type": "object", "required": [ "id", "orgId", "label", "status", "url", "createdAt", "updatedAt", "events", "resourceIds" ], "properties": { "id": { "description": "Webhook identifier (stringified numeric id)", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string", "example": "123" }, "orgId": { "description": "The unique identifier of the organization the webhook belongs to", "examples": [ "OR1223abc" ], "pattern": "^OR(.*)$", "type": "string", "example": "OR1223abc" }, "label": { "anyOf": [ { "description": "The webhook's label.", "examples": [ "my webhook label" ], "type": "string", "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": { "format": "uri", "description": "The endpoint that receives events from the webhook.", "examples": [ "https://example.com/" ], "type": "string", "example": "https://example.com/" }, "createdAt": { "description": "The date the webhook was created at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "updatedAt": { "description": "The date the webhook was updated at, in ISO 8601 format.", "examples": [ "2022-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2022-01-01T00:00:00Z" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The persisted webhook payload version.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "events": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } }, "resourceIds": { "description": "Phone number IDs to filter activity events, or `[\"*\"]` for all. Contact events are always org-wide regardless of this setting.", "examples": [ [ "PNabc123" ] ], "example": [ "PNabc123" ], "anyOf": [ { "type": "array", "items": { "pattern": "^PN(.*)$", "type": "string" } }, { "minItems": 1, "maxItems": 1, "type": "array", "items": { "const": "*", "type": "string" } } ] } } } ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Bad Request", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "/url: Expected required property, /url: Expected string", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/url", "message": "Expected required property", "schema": { "type": "String" } }, { "path": "/url", "message": "Expected string", "schema": { "type": "String" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } }, "delete": { "tags": [ "Webhooks" ], "summary": "Delete a webhook by ID", "description": "Delete a webhook by its unique identifier.", "operationId": "deleteHeaderVersionedWebhookById", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "204": { "description": "No Content", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}/rotate": { "post": { "tags": [ "Webhooks" ], "summary": "Rotate webhook signing secret", "description": "Rotates the signing secret for a webhook. The new secret will be returned in the response.", "operationId": "rotateHeaderVersionedWebhookSecret", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "key" ], "properties": { "key": { "description": "The webhook signing secret used to validate webhook signatures.", "examples": [ "whsec_exampleSecret" ], "type": "string", "example": "whsec_exampleSecret" } } } } } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}/events": { "get": { "tags": [ "Webhook Events" ], "summary": "List deliveries for a webhook", "description": "List events that have been dispatched to a webhook, one row per event with its current delivery status. Use the `after` query param to page through results.", "operationId": "listHeaderVersionedWebhookDeliveries", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "query", "name": "limit", "required": false, "schema": { "description": "Max number of items to return per page.", "default": 10, "maximum": 50, "minimum": 1, "type": "integer" } }, { "in": "query", "name": "after", "required": false, "schema": { "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "type": "string" }, "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "in": "query", "name": "status", "required": false, "schema": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Current delivery status of the event: `success` once any attempt succeeded, `pending` before the first attempt, `sending` mid-retry, or `failed` after all retries are exhausted.", "examples": [ "success" ] }, "example": "success" }, { "in": "query", "name": "eventTypes", "required": false, "schema": { "minItems": 1, "description": "Restrict results to deliveries of these event types.", "examples": [ [ "message.received" ] ], "type": "array", "items": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ] } }, "example": [ "message.received" ] }, { "in": "query", "name": "createdBefore", "required": false, "schema": { "description": "Only include deliveries dispatched before this ISO 8601 timestamp.", "examples": [ "2026-01-02T00:00:00Z" ], "format": "date-time", "type": "string" }, "example": "2026-01-02T00:00:00Z" }, { "in": "query", "name": "createdAfter", "required": false, "schema": { "description": "Only include deliveries dispatched after this ISO 8601 timestamp.", "examples": [ "2026-01-01T00:00:00Z" ], "format": "date-time", "type": "string" }, "example": "2026-01-01T00:00:00Z" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data", "nextCursor" ], "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "eventType", "status", "nextAttemptAt", "createdAt" ], "properties": { "id": { "description": "The unique identifier of the delivered event.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "type": "string", "example": "msg_2abcDEFghiJKLmnoPQRstu" }, "eventType": { "description": "The event type that was delivered. Typically one of `call.answered`, `call.completed`, `call.menu.selected`, `call.ringing`, `call.recording.completed`, `call.summary.completed`, `call.transcript.completed`, `message.received`, `message.delivered`, `message.failed`, `message.undelivered`, `contact.updated`, `contact.deleted`. `message.failed` indicates a send failure (retriable unless an error code marks it permanent), while `message.undelivered` indicates the message could not be delivered to the recipient or was blocked, and cannot be retried. Legacy webhooks may return other stored names.", "examples": [ "message.received" ], "type": "string", "example": "message.received" }, "status": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Current delivery status of the event: `success` once any attempt succeeded, `pending` before the first attempt, `sending` mid-retry, or `failed` after all retries are exhausted.", "examples": [ "success" ], "example": "success" }, "nextAttemptAt": { "anyOf": [ { "description": "The next scheduled retry time in ISO 8601 format. `null` when no further attempts are scheduled (terminal states).", "examples": [ "2026-01-01T00:05:00Z" ], "format": "date-time", "type": "string", "example": "2026-01-01T00:05:00Z" }, { "type": "null" } ] }, "createdAt": { "description": "The date the event was dispatched at, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2026-01-01T00:00:00Z" } } } }, "nextCursor": { "anyOf": [ { "examples": [ "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" ], "type": "string", "example": "eyJsYXN0SWQiOiJVU211a09NaXBhIn0" }, { "type": "null" } ] } } } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}/events/{eventId}": { "get": { "tags": [ "Webhook Events" ], "summary": "Get delivery detail for a webhook event", "description": "Get the delivery detail for a single event dispatched to a webhook, including the server response for each attempt.", "operationId": "getHeaderVersionedWebhookDelivery", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "path", "name": "eventId", "required": true, "schema": { "description": "The unique identifier of the dispatched event.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "type": "string" }, "example": "msg_2abcDEFghiJKLmnoPQRstu" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "data" ], "properties": { "data": { "type": "object", "required": [ "id", "eventType", "createdAt", "requestBody", "attempts" ], "properties": { "id": { "description": "The unique identifier of the dispatched event.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "type": "string", "example": "msg_2abcDEFghiJKLmnoPQRstu" }, "eventType": { "description": "The event type that was delivered.", "examples": [ "message.received" ], "type": "string", "example": "message.received" }, "createdAt": { "description": "The date the event was dispatched at, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2026-01-01T00:00:00Z" }, "requestBody": { "description": "The event payload that was sent to the webhook.", "examples": [ { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } ], "example": { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } }, "attempts": { "type": "array", "items": { "type": "object", "required": [ "id", "timestamp", "status", "responseStatusCode", "responseBody", "responseDurationMs", "triggerType", "url" ], "properties": { "id": { "description": "The unique identifier of this delivery attempt.", "examples": [ "atmpt_2abcDEFghiJKLmnoPQRstu" ], "type": "string", "example": "atmpt_2abcDEFghiJKLmnoPQRstu" }, "timestamp": { "description": "When this attempt was made, in ISO 8601 format.", "examples": [ "2026-01-01T00:00:00Z" ], "format": "date-time", "type": "string", "example": "2026-01-01T00:00:00Z" }, "status": { "type": "string", "enum": [ "success", "pending", "sending", "failed" ], "description": "Outcome of this specific attempt: `success` if the destination returned a 2xx, `failed` if it returned a non-2xx or no response, `sending` if the attempt is in flight, or `pending` if it is queued to run.", "examples": [ "success" ], "example": "success" }, "responseStatusCode": { "description": "HTTP status code returned by the destination server. `0` if no response was received.", "examples": [ 200 ], "type": "integer", "example": 200 }, "responseBody": { "description": "The raw response body returned by the destination server.", "examples": [ "{\"ok\":true}" ], "type": "string", "example": "{\"ok\":true}" }, "responseDurationMs": { "description": "Time taken for the destination server to respond, in milliseconds.", "examples": [ 123 ], "type": "number", "example": 123 }, "triggerType": { "type": "string", "enum": [ "scheduled", "manual" ], "description": "`scheduled` for automatic retries, `manual` for operator-initiated replays.", "examples": [ "scheduled" ], "example": "scheduled" }, "url": { "description": "The destination URL this attempt was sent to.", "examples": [ "https://example.com/webhook" ], "type": "string", "example": "https://example.com/webhook" } } } } } } } } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}/events/{eventId}/retry": { "post": { "tags": [ "Webhook Events" ], "summary": "Retry delivery of a webhook event", "description": "Queue a new delivery attempt for a previously dispatched event. The retry is processed asynchronously; use the delivery detail endpoint to inspect the new attempt.", "operationId": "retryHeaderVersionedWebhookDelivery", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "path", "name": "eventId", "required": true, "schema": { "description": "The unique identifier of the dispatched event to retry.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "type": "string" }, "example": "msg_2abcDEFghiJKLmnoPQRstu" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "type": "object", "properties": {} } } } }, "400": { "description": "Invalid Id", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0303400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Id", "type": "string" }, "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": { "const": "Invalid Id", "type": "string" } } }, "example": { "message": "/webhookId: Expected string to match '^[0-9]+$'", "docs": "https://quo.com/docs", "title": "Bad Request", "errors": [ { "path": "/webhookId", "message": "Expected string to match '^[0-9]+$'", "value": "abc123", "schema": { "type": "String", "pattern": "^[0-9]+$" } } ] } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } }, "/webhooks/{webhookId}/events/test": { "post": { "tags": [ "Webhook Events" ], "summary": "Send a test event to a webhook", "description": "Dispatches a canonical sample payload of the specified event type to the webhook URL so you can validate your endpoint before going live. The response returns the rendered sample payload so you can preview the body your endpoint will receive. Delivery to your URL is processed asynchronously; use the delivery detail endpoint to inspect the attempt.", "operationId": "sendHeaderVersionedTestWebhookEvent", "parameters": [ { "in": "path", "name": "webhookId", "required": true, "schema": { "description": "The unique identifier of a webhook", "examples": [ "123" ], "pattern": "^[0-9]+$", "type": "string" }, "example": "123" }, { "in": "header", "name": "Quo-Api-Version", "required": true, "schema": { "type": "string", "enum": [ "2026-03-30" ], "description": "API version header. Supported values: 2026-03-30" } } ], "security": [ { "apiKey": [] } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "required": [ "eventType" ], "properties": { "eventType": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" } } } } } }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "object", "required": [ "id", "apiVersion", "type", "createdAt", "data" ], "properties": { "id": { "description": "The event identifier inside the dispatched payload body — matches the `id` your endpoint will receive on the webhook POST. Note: this is a fixed sample identifier shared across test dispatches, not a per-delivery Svix message ID.", "examples": [ "msg_2abcDEFghiJKLmnoPQRstu" ], "type": "string", "example": "msg_2abcDEFghiJKLmnoPQRstu" }, "apiVersion": { "type": "string", "enum": [ "2026-03-30" ], "description": "The webhook payload version used to render this event.", "examples": [ "2026-03-30" ], "example": "2026-03-30" }, "type": { "type": "string", "enum": [ "call.answered", "call.completed", "call.forwarded", "call.menu.selected", "call.missed", "call.ringing", "call.recording.completed", "call.summary.completed", "call.transcript.completed", "call.voicemail.completed", "message.received", "message.delivered", "message.failed", "message.undelivered", "contact.updated", "contact.deleted", "task.assigned", "task.created", "task.completed", "task.updated", "task.deleted", "task.unassigned", "task.reopened", "task.duedate.removed", "task.duedate.updated", "task.overdue", "task.linked", "task.unlinked" ], "description": "Event type", "examples": [ "call.completed" ], "example": "call.completed" }, "createdAt": { "format": "date-time", "description": "When the test event was created.", "type": "string" }, "data": { "description": "Event-specific body. Shape depends on `type` — see the webhook event documentation.", "examples": [ { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } ], "example": { "context": { "contacts": { "ids": [ "CTsampleContact01234" ], "lookupStatus": "matched" }, "conversationId": "CNsampleconversation000000000000", "participants": { "external": [ "+15555551234" ], "resolution": "available", "workspace": [ "+15555555678" ] }, "phoneNumberId": "PNsamplephonenumber000000000000", "phoneNumberType": "shared", "userId": "USsampleus" }, "links": { "quo": "https://my.quo.com/inbox/PNsamplephonenumber000000000000/c/CNsampleconversation000000000000?at=ACsampleactivity0000000000000000" }, "resource": { "answeredAt": "2026-03-30T18:00:00.000Z", "completedAt": "2026-03-30T18:00:00.000Z", "createdAt": "2026-03-30T18:00:00.000Z", "direction": "incoming", "duration": 42, "hasVoicemail": false, "id": "ACsampleactivity0000000000000000", "status": "answered", "updatedAt": "2026-03-30T18:00:00.000Z" } } } } } } } }, "400": { "description": "Invalid Input Format", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title", "description" ], "properties": { "message": { "type": "string" }, "code": { "const": "0304400", "type": "string" }, "status": { "const": 400, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Invalid Input Format", "type": "string" }, "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": { "const": "Invalid Input Format", "type": "string" } } }, "example": { "message": "Invalid input format", "docs": "https://quo.com/docs", "title": "Invalid Input Format" } } } }, "401": { "description": "Unauthorized", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300401", "type": "string" }, "status": { "const": 401, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unauthorized", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are unauthorized to access the webhook", "docs": "https://quo.com/docs", "title": "Unauthorized" } } } }, "403": { "description": "Forbidden", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300403", "type": "string" }, "status": { "const": 403, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Forbidden", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "You are forbidden to access the webhook", "docs": "https://quo.com/docs", "title": "Forbidden" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0300404", "type": "string" }, "status": { "const": 404, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Not Found", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "Webhook with ID 123 not found", "docs": "https://quo.com/docs", "title": "Not Found" } } } }, "500": { "description": "Unknown Error", "content": { "application/json": { "schema": { "type": "object", "required": [ "message", "code", "status", "docs", "title" ], "properties": { "message": { "type": "string" }, "code": { "const": "0301500", "type": "string" }, "status": { "const": 500, "type": "number" }, "docs": { "const": "https://quo.com/docs", "type": "string" }, "title": { "const": "Unknown", "type": "string" }, "trace": { "type": "string" }, "errors": { "type": "array", "items": { "type": "object", "required": [ "path", "message", "schema" ], "properties": { "path": { "type": "string" }, "message": { "type": "string" }, "value": {}, "schema": { "type": "object", "required": [ "type" ], "properties": { "type": { "type": "string" } } } } } } } }, "example": { "message": "An unknown error occurred", "docs": "https://quo.com/docs", "title": "Unknown Error" } } } } } } } }, "components": { "schemas": {}, "securitySchemes": { "apiKey": { "in": "header", "name": "Authorization", "type": "apiKey" } } }, "servers": [ { "description": "Development server", "url": "https://dev-public-api.openphone.dev" } ], "tags": [ { "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 properties", "name": "Contact Properties" }, { "description": "Operations related to conversations", "name": "Conversations" }, { "description": "Operations related to text messages", "name": "Messages" }, { "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": [] } ] }